Désactivation

Vue d'ensemble

La commande deactivate (désactivation) vous permet de désactiver une carte-cadeau émise par Moneris, la rendant inutilisable. Cette action est permanente et NE PEUT PAS être annulée. S’il reste un solde sur la carte-cadeau Moneris, ce montant sera retourné dans la réponse de cette requête. Les fonds peuvent être transférés vers une autre carte ou remis au client par le commerçant.

Commande de désactivation

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 contenant 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 provenant de l’achat	V50	Facultatif
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 des transactions liées	V50	Facultatif
terminalId	String (chaîne)	ID du terminal de destination	F8	Facultatif
userName	String (chaîne)	Identifiant unique pour le caissier / l’utilisateur	V30	Facultatif
customIdData	String (chaîne)	Champ personnalisé	V50	Facultatif
action	String (chaîne)	"deactivate"	V50	Obligatoire
progressStatus	String (chaîne)	Si la valeur est définie sur "True", le terminal retournera la progression vers le PDV Remarque : Cette fonctionnalité est uniquement disponible en intégration directe	V5	Facultatif
cardNumber	String (chaîne)	Détails de la piste 2 décrits dans ISO 7813 ou saisie manuelle	V200	Facultatif
cvc	String (chaîne)	Code de vérification de la carte	V10	Facultatif

{
   "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":"deactivate"
         }
      ]
   }
}

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 contenant toutes les requêtes de transaction	-	-
response	Array (tableau)	Contient les données applicables à la requête de transaction	-	-
orderId	String (chaîne)	Le terminal renverra soit l’orderId de la requête, soit générera un nouvel orderId unique si aucun orderId n’était présent dans la 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 des transactions liées	V50	Facultatif
action	String (chaîne)	"activate"	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
balance	String (chaîne)	Solde du compte	V9	Conditionnel
tenderType	String (chaîne)	Type de paiement : crédit, débit, cadeau, etc.	V50	Conditionnel
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
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
maskedPan	String (chaîne)	Numéro de compte principal (PAN) masqué	V21	Conditionnel
completed	String (chaîne)	"true" ou "false"	V5	Obligatoire
receipt	String (chaîne)	Données du reçu financier envoyées en encodage ISO-8895-1	V4000	Conditionnel
receiptChoice	String (chaîne)	Les options de remise du reçu au titulaire de carte au moment de la transaction. Les valeurs valides incluent : PRINT (option par défaut), EMAIL, SMS, NONE.	V10	Conditionnel
terminalId	String (chaîne)	ID du terminal de destination	F8	Obligatoire

{
   "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",
            "maskedPan":"example_maskedPan",
            "action":"deactivate",
            "receipt":"example_receipt",
            "receiptChoice":"PRINT",
            "terminalId":"example_terminalId"
         }
      ]
   }
}

Erreues

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