Annuler
Vue d'ensemble
Une transaction peut être annulée à partir de le point de vente (PDV) avant que le titulaire de carte ne présente sa carte. Une fois la transaction traitée, elle ne peut plus être annulée.
Liste des scénarios de codage qui utilisent cet endpoint (le point de terminaison) :
REMARQUE
Ceci est uniquement disponible pour la méthode d’intégration Directe, et non pour Cloud ou App-à-app.
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 | V50 | 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 | ||
| idempotencyKey | String (chaîne) | Identifiant unique de transaction pour éviter les requêtes en double | V50 | Obligatoire |
| terminalId | String (chaîne) | Numéro ECR du terminal particulier auquel vous vous adressez | F8 | Facultatif |
| action | String (chaîne) | « cancel » (annuler) | V50 | Obligatoire |
{
"apiVersion": "3.0",
"istConfigCode": "example_istConfigCode",
"dataId": "example_dataId",
"dataTimestamp": "1969-12-31 23:59:59",
"data": {
"request": [
{
"idempotencyKey": "example_idempotencyKey",
"terminalId": "example_terminalId",
"action": "cancel"
}
]
}
}
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 | ||
| idempotencyKey | String (chaîne) | Identifiant unique de transaction pour éviter les requêtes en double | V50 | Obligatoire |
| action | String (chaîne) | « cancel » (annuler) | 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 |
| completed | String (chaîne) | « true » (valeur booléenne vraie) ou « false » (valeur booléenne fausse) | V5 | Obligatoire |
{
"apiVersion": "3.0",
"statusCode": "example_statusCode",
"status": "example_status",
"dataId": "example_dataId",
"dataTimestamp": "1969-12-31 23:59:59",
"data": {
"response": [
{
"idempotencyKey": "example_idempotencyKey",
"statusCode": "example_statusCode",
"status": "example_status",
"completed": "true",
"action": "cancel"
}
]
}
}
Erreurs
Si votre réponse contient des erreurs, consultez la page Erreurs pour une description détaillée de chacune.