Remboursement carte présente
Vue d'ensemble
Un remboursement carte présente est le retour de fonds vers une carte qui n’est pas associé à un achat ou à une preAuthorization (préautorisation). Comme ce remboursement n’est pas lié à une transaction spécifique, aucun plafond n’est imposé sur le montant remboursé.
Pour effectuer un remboursement carte enregistrée lié à une transaction spécifique, consultez la section remboursement carte enregistrée permet.
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) | « independentRefund » (remboursement indépendant) | V50 | Obligatoire |
| totalAmount | String (chaîne) | Montant total de la transaction | V9 | Obligatoire |
| safAllowed | String (chaîne) | Bascule pour SAF | V5 | Facultatif |
| dynamicDescriptor | String (chaîne) | Description définie par le commerçant | V20 | Facultatif |
| progressStatus | String (chaîne) | Si la valeur est définie sur « true » (valeur booléenne vraie), le terminal renverra la progression à l’ECR Remarque : cette fonctionnalité est uniquement disponible en intégration directe (Direct Integration) | V5 | Facultatif |
| modifier | String (chaîne) | Énumération qui classe davantage la transaction | V24 | Facultatif |
| realTimeUniqueId | String (chaîne) | Requis pour les remboursements dans le cadre d’une transaction Installment by Visa. La valeur doit correspondre à celle reçue dans la réponse d’achat (Purchase) ou de préautorisation (Pre-Authorization) | F15 | Conditionnel |
| language | String (chaîne) | Valeurs valides : « EN » et « FR ». Si aucune valeur n’est fournie, l’application de paiement utilisera la langue définie dans le TMS | F2 | Facultatif |
| subtotalAmount | String (chaîne) | Montant sans taxes ni frais | V9 | Facultatif |
| taxes | Array (tableau) | Maximum de 5 objets de taxe | ||
| taxName | String (chaîne) | Nom à afficher sur le reçu (hst, gst, etc.) | V15 | Facultatif |
| taxAmount | String (chaîne) | Montant correspondant | V9 | Conditionnel |
{
"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":"independentRefund",
"totalAmount":"example_totalAmount"
}
]
}
}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 l’ensemble de la demande de transaction | 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 demande (AAAA-MM-JJ HH:MM:SS) | F19 | Obligatoire |
| data | Object (objet) | Objet contenant toutes les demandes de transaction | ||
| response | Array (tableau) | Contient les données applicables à la demande de transaction | ||
| orderId | String (chaîne) | Le terminal renverra soit l’orderId (ID de commande) de la demande, soit générera un nouvel identifiant unique s’il n’était pas présent dans la demande | V50 | Obligatoire |
| transactionId | String (chaîne) | Identifiant unique pour cette demande | V50 | Obligatoire |
| idempotencyKey | String (chaîne) | Identifiant unique de transaction pour éviter une demande en double | V50 | Obligatoire |
| linkId | String (chaîne) | Identifiant utilisé pour regrouper des transactions liées | V50 | Facultatif |
| action | String (chaîne) | "independentRefund" | V50 | Obligatoire |
| statusCode | String (chaîne) | Code d’état pour la demande individuelle | V4 | Obligatoire |
| status | String (chaîne) | Description du code d’état individuel | V50 | Obligatoire |
| saf | String (chaîne) | Identifiant pour la transaction SAF | V5 | Obligatoire |
| safCounter | String (chaîne) | Nombre de transactions SAF non traitées | V3 | Conditionnel |
| totalAmount | String (chaîne) | Reprise du montant total de la transaction de la demande | V9 | Obligatoire |
| approvedAmount | String (chaîne) | Montant du paiement reçu / approuvé | V9 | Conditionnel |
| 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 masqué (PAN) | V21 | Conditionnel |
| completed | String (chaîne) | "true" (vrai) ou "false" (faux) | V5 | Obligatoire |
| receipt | String (chaîne) | Données du reçu financier envoyées en utilisant le codage ISO-8895-1 | V4000 | Conditionnel |
| receiptChoice | String (chaîne) | Les choix de remise du reçu au titulaire de 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 |
| dccOptIn | String (chaîne) | Ce champ indique une transaction avec conversion dynamique de devise (DCC) | V5 | Facultatif |
{
"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",
"saf":"false",
"responseCode":"example_responseCode",
"iso":"example_iso",
"approvedAmount":"example_approvedAmount",
"totalAmount":"example_totalAmount",
"tenderType":"example_tenderType",
"cardType":"example_cardType",
"sequenceNum":"example_sequenceNum",
"realTimeUniqueId":"example_realTimeUniqueId",
"authCode":"example_authCode",
"formFactor":"example_formFactor",
"maskedPan":"example_maskedPan",
"action":"independentRefund",
"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.