Consultation de solde
Vue d'ensemble
La commande balance inquiry (consultation de solde) permet à un client de vérifier le solde d’une carte prépayée (Visa, Mastercard, American Express ou Discover) ou d’une carte-cadeau émise par Moneris.Le solde sera affiché uniquement sur le terminal, et non renvoyé dans la réponse, pour des raisons de confidentialité.
REMARQUE
Pour en savoir plus sur le programme de cartes-cadeaux Moneris, consultez le lien suivant.
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 d’un achat (Purchase) | V50 | Obligatoire |
| idempotencyKey | String (chaîne) | Identifiant unique de transaction pour éviter les requêtes 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) | « balanceInquiry » (consultation de solde) | V50 | Obligatoire |
| progressStatus | String (chaîne) | Si la valeur est définie sur « true » (valeur booléenne vraie), le terminal renverra la progression à le PDV Remarque : Cette fonctionnalité est uniquement disponible en intégration directe (Direct Integration) | V5 | Facultatif |
| modifier | String (chaîne) | Valeur du modificateur « scan », « CNP » | V24 | 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":"balanceInquiry"
}
]
}
}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) | 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 les requêtes en double | V50 | Obligatoire |
| linkId | String (chaîne) | ID utilisé pour regrouper des transactions liées | V50 | Facultatif |
| action | String (chaîne) | « balanceInquiry » (consultation de solde) | V50 | Obligatoire |
| statusCode | String (chaîne) | Code d’état pour la requête individuelle | V4 | Obligatoire |
| status | String (chaîne) | Description du statusCode individuel (Code d’état) | V50 | Obligatoire |
| tenderType | String (chaîne) | Type de paiement : crédit (Credit), débit (Debit), cadeau (Gift), 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 en temps réel de la transaction Moneris | 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 |
| 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 |
{
"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",
"tenderType":"example_tenderType",
"cardType":"example_cardType",
"sequenceNum":"example_sequenceNum",
"realTimeUniqueId":"example_realTimeUniqueId",
"authCode":"example_authCode",
"formFactor":"example_formFactor",
"maskedPan":"example_maskedPan",
"action":"balanceInquiry",
"terminalId":"example_terminalId"
}
]
}
}Erreurs
Si votre réponse contient des erreurs, consultez la page Erreurs pour une description détaillée de chacune.