Pré‑saisie de carte

Vue d'ensemble

Ce hook permet une activation avant la détection de la carte, mais après les modificateurs tels que les pourboires, afin de prendre en charge des cas d’utilisation où les transactions sont traitées par des moyens alternatifs, tels que des cartes‑cadeaux tierces ou des portefeuilles numériques, des programmes de fidélité ou des dons de bienfaisance.

Requête de pré‑saisie de carte

Element	Type	Description	Size	Requis
apiVersion	String	Numéro de version de l’API	V20	Requis
action	String	"PRE_CARD_ENTRY"	V30	Requis
transactionType	String	Transaction que le terminal est en train d’effectuer. Valeurs valides : "PURCHASE" "PRE_AUTHORIZATION" "PRE_AUTHORIZATION_COMPLETION" "REFUND" "INDEPENDENT_REFUND" "VOID"	F8	Requis
requestDateTime	String	Date et heure de la requête (YYYY‑MM‑DDTHH:MM:SSZ). Le format est basé sur le profil Internet standard de RFC 3339 — un sous‑ensemble de ISO 8601.	F20	Requis
language	String	Langue du terminal. Fournit le code de langue à deux lettres conformément à la norme ISO 639‑1. Pour obtenir la liste complète des codes de langue, veuillez visiter : https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes.	V30	Requis
correlationId	String	Permet de corréler une série de requêtes au sein d’un même flux.	V50	Requis
terminalId	String	Identifiant du terminal.	F8	Requis
merchantId	String	Identifiant du marchand.	V13	Requis
merchantName	String	Nom du marchand.	V100	Requis
merchantAddress	Object	Adresse du marchand.
unitNumber	String	Numéro d’unité.	V19	Optionnel
streetNumber	String	Numéro de rue.	V19	Optionnel
streetName	String	Nom complet de la rue.	V100	Optionnel
province	String	Code ISO 3166‑2 de la province ou de l’état.	V3	Optionnel
city	String	Nom de la ville / localité.	V100	Optionnel
postalCode	String	Code postal.	V30	Optionnel
country	String	Code pays conformément à iso-3166-1-alpha-2	V2	Optionnel
totalAmount	Object	Montant total de la transaction.		Requis
amount	String	La valeur doit être exprimée en cents. Par conséquent, 10,59 $ doit être envoyé sous la forme 1059.	V10	Requis
currency	String	Code de devise à trois lettres conformément à la norme ISO 4217. Pour obtenir la liste complète des codes de devises, veuillez visiter : ISO 4217	V4	Requis
amountDetails	Object	Détail de ventilation des montants.		Optionnel
tipAmount	Object	Montant du pourboire.		Optionnel
amount	String	La valeur doit être exprimée en cents. Par conséquent, 10,59 $ doit être envoyé sous la forme 1059.	V10	Requis
currency	String	Code de devise à trois lettres conformément à la norme ISO 4217. Pour obtenir la liste complète des codes de devises, veuillez visiter : ISO 4217	V4	Requis
subtotalAmount	Object	Montant du sous‑total (avant taxes).
amount	String	La valeur doit être exprimée en cents. Par conséquent, 10,59 $ doit être envoyé sous la forme 1059.	V10	Requis
currency	String	Code de devise à trois lettres conformément à la norme ISO 4217. Pour obtenir la liste complète des codes de devises, veuillez visiter : ISO 4217	V4	Requis
taxes	Array	Maximum de 5 objets de taxe.
taxName	String	Nom affiché sur le reçu (HST, GST, etc.).	V15
taxAmount	Object	Montant correspondant à la taxe.
amount	String	La valeur doit être exprimée en cents. Par conséquent, 10,59 $ doit être envoyé sous la forme 1059.	V10	Requis
currency	String	Code de devise à trois lettres conformément à la norme ISO 4217. Pour obtenir la liste complète des codes de devises, veuillez visiter : ISO 4217	V4	Requis

{
  "apiVersion": "2025-01-09",
  "action": "PRE_CARD_ENTRY",
  "transactionType": "PURCHASE",
  "requestDateTime": "2025-12-31T23:59:60Z",
  "language": "en",
  "correlationId": "example_correlationId",
  "terminalId": "example_terminalId",
  "merchantId": "example_merchantId",
  "merchantName": "example_merchantName",
  "merchantAddress": {
    "unitNumber": "1A",
    "streetNumber": "12",
    "streetName": "Yonge St",
    "province": "ON",
    "city": "Toronto",
    "postalCode": "M4W 3H7",
    "country": "CA"
  },
  "totalAmount": {
    "amount": "12000",
    "currency": "CAD"
  },
  "amountDetails": {
    "subtotalAmount": {
      "amount": "10000",
      "currency": "CAD"
    },
    "tipAmount": {
      "amount": "1000",
      "currency": "CAD"
    },
    "taxes": [
      {
        "taxName": "HST",
        "taxAmount": {
          "amount": "500",
          "currency": "CAD"
        }
      },
      {
        "taxName": "GST",
        "taxAmount": {
          "amount": "500",
          "currency": "CAD"
        }
      }
    ]
  }
}

Réponse de pré‑saisie de carte

Element	Type	Description	Size	Requis
apiVersion	String	Numéro de version de l’API	V20	Requis
correlationId	String	Écho de la requête	V50	Requis
responseDateTime	String	Date et heure de la réponse (YYYY‑MM‑DDTHH:MM:SSZ). Le format est basé sur le profil Internet standard de RFC 3339 — un sous‑ensemble de ISO 8601.	F20	Requis
action	String	"PRE_CARD_ENTRY"	V50	Requis
status	String	Code d'état HTTP de la requête de transaction.	F3	Requis
updatedTotalAmount	Object	Montant total de la transaction modifié par l’application tierce. Ce montant peut être supérieur ou inférieur au montant de la transaction d’origine.		Optionnel
amount	String	La valeur doit être exprimée en cents. Par conséquent, 10,59 $ doit être envoyé sous la forme 1059.	V10	Requis
currency	String	Code de devise à trois lettres conformément à la norme ISO 4217. Pour obtenir la liste complète des codes de devises, veuillez visiter : ISO 4217	V4	Requis

{
  "apiVersion": "3.0",
  "correlationId": "example_correlationId",
  "responseDateTime": "2025-12-31T23:59:60Z",
  "action": "PRE_CARD_ENTRY",
  "status": "200",
  "updatedTotalAmount": {
    "amount": "2000",
    "currency": "CAD"
  }
}