Demande Preload

post

https://gatewayt.moneris.com/chktv2/request/request.php

La demande Preload permet de créer de façon sécurisée une instance Moneris Checkout au moment de la transaction. Elle prend la forme d'une demande POST serveur à serveur qui utilise le format JSON décrit ci-dessous.

Demandes récentes

Connectez-vous pour voir l'historique complet des demandes

Heure	Statut	Agent utilisateur
Récupération des demandes récentes…

Loading…

La réponse à la demande Preload contient un numéro de ticket qui désigne l'instance de façon unique. Ce numéro doit être transmis dans l'appel JavaScript pour que la page Moneris Checkout s'affiche dans le navigateur.

Body Params

store_id

string

required

Identifiant unique fourni par Moneris au moment de l'ouverture du compte de commerçant.

api_token

string

required

Chaîne alphanumérique unique attribuée au moment de l'activation du compte de commerçant.

checkout_id

string

required

Désigne la configuration Moneris Checkout. Cette valeur est fournie au moment de la configuration de la page dans le Centre de ressources pour commerçants.

txn_total

string

required

Montant total de la transaction, en dollars.

environment

string

enum

required

Indique l'étape de développement à laquelle la demande est transmise.

testing = qa

production = prod

Allowed:

action

string

enum

required

Defaults to preload

Type de demande transmise au serveur Moneris Checkout : preload ou receipt.

Allowed:

order_no

string

Le numéro de commande est un identifiant unique associé à chaque transaction financière.

Chaîne alphanumérique de 50 caractères. Certains caractères spéciaux ne sont pas admis:
< > $ % = ? ^ " { } [ ] \

cust_id

string

Champ défini par le commerçant pouvant servir d'identifiant. Ce champ est interrogeable à partir du Centre de ressources pour commerçants de Moneris.

Chaîne alphanumérique de 50 caractères. Certains caractères spéciaux ne sont pas admis:
< > $ % = ? ^ " { } [ ] \

data_key_format

string

enum

Chaîne alphanumérique de 2 caractères qui précise le format de la clé de données retournée. Si le champ est laissé vide, le format par défaut est une chaîne alphanumérique de 25 caractères.

NOTE : si la demande utilise un format assorti d'une contrainte d'unicité, signalé par le suffixe [U], toute tentative de tokeniser une carte déjà conservée sous ce compte de commerçant retourne le jeton existant plutôt qu'un nouveau jeton.

Valeurs possibles:

0 = clé de données alphanumérique de 25 caractères.
0U = clé de données alphanumérique unique de 25 caractères.
1 = les 6 premiers et les 4 derniers chiffres du numéro de carte, séparés par des caractères aléatoires. La longueur du numéro de carte est conservée.
1U = les 6 premiers et les 4 derniers chiffres du numéro de carte, séparés par des caractères aléatoires. La longueur du numéro de carte est conservée. Valeur unique.
2 = les 6 premiers et les 4 derniers chiffres du numéro de carte, séparés par des caractères aléatoires. La longueur du numéro de carte n'est pas conservée.
2U = les 6 premiers et les 4 derniers chiffres du numéro de carte, séparés par des caractères aléatoires. La longueur du numéro de carte n'est pas conservée. Valeur unique.
4U = les 6 premiers et les 4 derniers chiffres du numéro de carte. Le 7e caractère est une lettre aléatoire et les autres caractères intermédiaires sont aléatoires. La longueur est forcée à 16 caractères. Valeur unique.

Allowed:

dynamic_descriptor

string

Description définie par le commerçant, transmise transaction par transaction, qui figure sur le relevé de carte de crédit à la suite du nom d'entreprise du commerçant. Selon l'émetteur de la carte, le relevé présente généralement le descripteur dynamique à la suite du nom d'entreprise existant, séparé par le caractère « / ». Les caractères excédentaires sont tronqués.

NOTE : la limite maximale de 22 caractères comprend le caractère "/".

Chaîne alphanumérique de 20 caractères, pour un total de 22 caractères en comptant le nom du commerçant et le séparateur.

NOTE : certains caractères spéciaux ne sont pas admis:
< > $ % = ? ^ " { } [ ] \

language

string

enum

Détermine la langue d'affichage de l'information dans Moneris Checkout.

Allowed:

data_key

string

Identifiant unique alphanumérique de 25 caractères associé à un profil de la voûte. Il sert, lors des transactions financières ultérieures, à rattacher une transaction à ce profil. La clé de données est produite par Moneris et retournée dans l'objet Receipt au moment de l'enregistrement initial du profil.

NOTE : ne transmettre ce champ qu'avec une opération Vault Card Update, sans quoi la demande Preload est refusée. Cette fonction n'est offerte que si le type de transaction Preload transmis est une vérification de carte.

ask_cvv

string

enum

Lorsque la valeur est Y, Moneris Checkout demande au titulaire de carte de saisir son CVV s'il choisit une carte de paiement conservée sous forme de jeton.

NOTE : ce champ ne s'applique que si l'objet Token est transmis.

Allowed:

recur

object

Contient les champs liés à la facturation récurrente.

cart

object

Le panier virtuel et son contenu.

contact_details

object

Coordonnées du client. Cet objet est retourné dans la réponse à la demande Receipt sous la forme de l'objet de réponse cust_info.

shipping_details

object

Renseignements de livraison du client.

billing_details

object

Renseignements de facturation du client.

token

array of objects

Tableau contenant de 1 à 3 paires composées d'une clé de données unique et de l'identifiant d'émetteur associé. Chaque paire représente une carte de paiement conservée dans la voûte Moneris. Ces valeurs servent aux transactions de paiement par jeton.

token

kount_udf

object

Objet contenant de 1 à 14 paires clé-valeur correspondant aux champs définis par l'utilisateur (UDF) de Kount. Cette fonction n'est offerte qu'aux commerçants qui utilisent Kount Enterprise.

Ces UDF sont des paires clé-valeur d'attributs personnalisés transmises à Moneris Checkout au moment de la demande Preload. Moneris Checkout les transmet ensuite à Kount dans le cadre de la demande d'évaluation du risque. Pour transmettre ces données à Kount, créer au préalable les entrées "label" correspondantes dans la console Kount Agent Web Console (AWC), avant de transmettre des valeurs dans les demandes Preload. Seuls les champs configurés au préalable figurent dans le portail et peuvent être consultés.

Responses

200Traitement réussi de la demande

400Demande incorrecte