Activation/Chargement
Vue d'ensemble
La commande activate/load (activation/chargement) vous permet d’activer une carte-cadeau et de spécifier le montant à y charger. Lors de son utilisation, elle déclenche le processus d’activation et de financement de la carte selon le champ totalAmount (montant total) fourni dans la requête.
Vous pouvez aussi utiliser cette commande pour activer des cartes-cadeaux à montant fixe. Dans ce cas, la carte sera activée pour une valeur prédéfinie, indépendamment du montant indiqué dans totalAmount. Pour utiliser des cartes-cadeaux à montant fixe, veuillez contacter l’équipe Gift and Loyalty à l’adresse courriel dédiée.
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 les 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) | "activate" | V50 | Obligatoire |
| 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 carte | V10 | Facultatif |
| totalAmount | String (chaîne) | Montant total de la transaction | V10 | Obligatoire |
| progressStatus | String (chaîne) | Si la valeur est définie sur "True", le terminal renverra la progression au PDV Remarque : Cette fonctionnalité est uniquement disponible en intégration directe | V5 | 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",
"totalAmount":"example_totalAmount",
"action":"activate"
}
]
}
}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 code d’état (statusCode) | 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) | 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 | 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 code d’état (statusCode) individuel | V50 | Obligatoire |
| balance | String (chaîne) | Solde du compte | V9 | Conditionnel |
| loadedAmount | String (chaîne) | Montant chargé | 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 |
| cardStatus | String (chaîne) | Statut de la carte | V10 | 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 retourné par l’institution émettrice | V8 | Conditionnel |
| maskedPan | String (chaîne) | Numéro de compte principal masqué (PAN) | 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) | Choix de la méthode de remise du reçu au titulaire de la carte au moment de la transaction. Valeurs valides : PRINT (option par défaut), EMAIL, SMS, NONE. | V10 | Conditionnel |
| terminalId | String (chaîne) | ID du terminal de destination | F8 | Obligatoire |
| totalAmount | String (chaîne) | Renvoi du montant total de la transaction depuis la requête | V9 | 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",
"loadedAmount":"example_approvedAmount",
"totalAmount":"example_totalAmount",
"tenderType":"example_tenderType",
"cardType":"example_cardType",
"sequenceNum":"example_sequenceNum",
"realTimeUniqueId":"example_realTimeUniqueId",
"authCode":"example_authCode",
"maskedPan":"example_maskedPan",
"action":"activate",
"receipt":"example_receipt",
"receiptChoice":"PRINT",
"terminalId":"example_terminalId"
}
]
}
}Erreurs
Si votre réponse contient des erreurs, consultez la page Erreurs pour une description détaillée de chacune.