Vérification de carte

Vue d'ensemble

La commande card verification (vérification de carte) vous permet de valider une carte sans facturer le client. Elle peut être utilisée lorsque vous souhaitez tokeniser une carte sans générer de transaction financière. Le jeton obtenu peut ensuite servir à configurer des paiements récurrents futurs, sans que la carte soit présente. Pour en savoir plus sur la tokenisation, consultez le lien fourni.

Commande de vérification de carte

📘
REMARQUE
La vérification de carte n’est pas prise en charge pour les cartes Interac, JCB et UnionPay.

Structure de la requête

Élément	Type	Description	Taille	Obligatoire
apiVersion	String (chaîne)	Numéro de version de l’API	V20	Obligatoire
istConfigCode	String (chaîne)	Code de configuration d’intégration fourni par Moneris	V25	Obligatoire
dataId	String (chaîne)	Identifiant unique défini par le commerçant pour l’objet de données	V50	Obligatoire
dataTimestamp	String (chaîne)	Date et heure de la requête (AAAA-MM-JJ HH:MM:SS)	F19	Obligatoire
data	Object (objet)	Objet qui contient toutes les requêtes de transaction
request	Array (tableau)	Contient les données applicables à la requête de transaction
orderId	String (chaîne)	ID de commande issu de l’achat	V50	Obligatoire
idempotencyKey	String (chaîne)	Identifiant unique de transaction pour éviter une requête en double	V50	Obligatoire
linkId	String (chaîne)	ID utilisé pour regrouper les transactions liées	V50	Optionnel
terminalId	String (chaîne)	ID du terminal de destination	F8	Optionnel
userName	String (chaîne)	Identifiant unique pour le caissier / l’utilisateur	V30	Optionnel
customIdData	String (chaîne)	Champ personnalisé	V50	Optionnel
action	String (chaîne)	"cardVerification" (vérification de carte)	V50	Obligatoire
progressStatus	String (chaîne)	Si la valeur est définie sur "True", le terminal renverra la progression vers le PDV Remarque : cette fonctionnalité est uniquement disponible en intégration directe	V5	Optionnel
modifier	String (chaîne)	Valeur du modificateur « scan », « CNP »	V24	Optionnel
getHash	String (chaîne)	Si « true », la transaction renverra le hachage	V5	Optionnel

Exemple de requête

{
  "apiVersion": "3.0",
  "istConfigCode": "example_istConfigCode",
  "dataId": "example_dataId",
  "dataTimestamp": "1969-12-31 23:59:59",
  "data": {
    "request": [
      {
        "orderId": "example_orderId",
        "idempotencyKey": "example_idempotencyKey",
        "action": "cardVerification"
      }
    ]
  }
}

Structure de la réponse

Élément	Type	Description	Taille	Obligatoire
apiVersion	String (chaîne)	Numéro de version de l’API	V20	Obligatoire
statusCode	String (chaîne)	Code d’état pour la requête de transaction globale	V4	Obligatoire
status	String (chaîne)	Description du statusCode (code d’état)	V4	Obligatoire
dataId	String (chaîne)	Identifiant unique défini par le commerçant pour l’objet de données	V50	Obligatoire
dataTimestamp	String (chaîne)	Date et heure de la requête (AAAA-MM-JJ HH:MM:SS)	F19	Obligatoire
data	Object (objet)	Objet qui contient toutes les requêtes de transaction
response	Array (tableau)	Contient les données applicables à la requête de transaction
orderId	String (chaîne)	Identifiant unique pour cette requête	V50	Obligatoire
transactionId	String (chaîne)	Identifiant unique pour cette requête	V50	Obligatoire
idempotencyKey	String (chaîne)	Identifiant unique de transaction pour éviter une requête en double	V50	Obligatoire
linkId	String (chaîne)	ID utilisé pour regrouper les transactions liées	V50	Optionnel
action	String (chaîne)	"cardverification" (vérification de carte)	V50	Obligatoire
statusCode	String (chaîne)	Code d’état pour la requête individuelle	V4	Obligatoire
status	String (chaîne)	Description du statusCode (code d’état) individuel	V50	Obligatoire
tenderType	String (chaîne)	Type de paiement : crédit, débit, cadeau, etc.	V50	Obligatoire
cardType	String (chaîne)	Type de carte : V, M, P, AX, etc.	V2	Conditionnel
cardName	String (chaîne)	Nom de la carte : Visa, MasterCard, Interac, Amex, etc.	V25	Conditionnel
sequenceNum	String (chaîne)	Numéro de séquence	V18	Conditionnel
realTimeUniqueId	String (chaîne)	Identifiant unique de transaction Moneris en temps réel	F15	Conditionnel
responseCode	String (chaîne)	Code de réponse de l’hôte Moneris	V3	Conditionnel
iso	String (chaîne)	Code de réponse ISO	V2	Conditionnel
authCode	String (chaîne)	Code d’autorisation renvoyé par l’institution émettrice	V8	Conditionnel
formFactor	String (chaîne)	Données spécifiques EMV	F2	Conditionnel
maskedPan	String (chaîne)	Numéro de compte principal (PAN) masqué	V21	Conditionnel
cvdResults	String (chaîne)	Ce champ indique si le chiffre de vérification du titulaire de carte (CVD) est présent et, le cas échéant, le résultat de la vérification CVD	F2	Conditionnel
hashValue	String (chaîne)	Hachage des données de la carte	F64	Conditionnel
completed	String (chaîne)	"true" (valeur booléenne vraie) ou "false" (valeur booléenne fausse)	V5	Obligatoire
terminalId	String (chaîne)	ID du terminal de destination	F8	Obligatoire

Exemple de réponse

{
  "apiVersion": "3.0",
  "statusCode": "example_statusCode",
  "status": "example_status",
  "dataId": "example_dataId",
  "dataTimestamp": "1969-12-31 23:59:59",
  "data": {
    "response": [
      {
        "orderId": "example_orderId",
        "transactionId": "example_transactionId",
        "statusCode": "example_statusCode",
        "status": "example_status",
        "idempotencyKey": "example_idempotencyKey",
        "completed": "true",
        "responseCode": "example_responseCode",
        "iso": "example_iso",
        "approvedAmount": "example_approvedAmount",
        "tenderType": "example_tenderType",
        "cardType": "example_cardType",
        "sequenceNum": "example_sequenceNum",
        "realTimeUniqueId": "example_realTimeUniqueId",
        "authCode": "example_authCode",
        "formFactor": "example_formFactor",
        "maskedPan": "example_maskedPan",
        "action": "cardVerification",
        "terminalId": "example_terminalId"
      }
    ]
  }
}

Erreurs

Si votre réponse contient des erreurs, consultez la page Erreurs pour une description détaillée de chacune.