--- updatedAt: 2026-08-14T03:37:12.000Z agentTools: projectIndex: https://developer.moneris.com/moneris-api/fr/llms.txt --- # Liste des paiements Renvoie une liste paginée de paiements. # Définition OpenAPI ```json { "openapi": "3.0.3", "info": { "version": "2.15.1", "title": "API de Moneris", "description": "Plateforme des API de Moneris\n\n\n\n[\"Exécuter](https://god.gw.postman.com/run-collection/25575461-f04750a0-88e9-4c83-8b58-a3aff15eeea8?action=collection%2Ffork&collection-url=entityId%3D25575461-f04750a0-88e9-4c83-8b58-a3aff15eeea8%26entityType%3Dcollection%26workspaceId%3D5d2a9a0f-57a7-441c-b2af-fe6315e80a08)", "termsOfService": "https://www.moneris.com/fr-ca/juridiques/conditions-utilisation", "contact": { "url": "https://api-developer.moneris.com", "email": "api@moneris.com" }, "license": { "name": "Moneris", "url": "https://developer.moneris.com/Agreements/Terms%20of%20Use" }, "x-audience": "external-public" }, "servers": [ { "url": "https://api.sb.moneris.io", "description": "Serveur de test (utilise des données de test)" }, { "url": "https://api.moneris.io", "description": "Serveur de production (utilise des données réelles)" } ], "tags": [ { "name": "Paiements", "description": "Effectuer et gérer les paiements" } ], "paths": { "/payments": { "parameters": [ { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/correlationId" }, { "$ref": "#/components/parameters/merchantId" } ], "get": { "summary": "Liste des paiements", "description": "Renvoie une liste paginée de paiements.", "operationId": "getPayments", "security": [ { "OAuth2": [ "payment.read" ] }, { "OAuth2": [ "payment.write" ] }, { "ApiKeyAuth": [] } ], "tags": [ "Paiements" ], "parameters": [ { "$ref": "#/components/parameters/pageBeforeCursor" }, { "$ref": "#/components/parameters/pageLimit" }, { "$ref": "#/components/parameters/createdFrom" }, { "$ref": "#/components/parameters/createdTo" } ], "responses": { "200": { "$ref": "#/components/responses/listPaymentsResponse" }, "400": { "$ref": "#/components/responses/invalidListbadRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "429": { "$ref": "#/components/responses/tooManyRequests" }, "500": { "$ref": "#/components/responses/internalServer" }, "503": { "$ref": "#/components/responses/serviceUnavailable" } } } } }, "components": { "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "X-Api-Key", "description": "Une clé API est un jeton fourni par un client lors de ses appels API.\n\nLes clés API sont censées être un secret que seuls le client et le serveur connaissent.\n" }, "OAuth2": { "type": "oauth2", "description": "OAuth 2.0 est un protocole d'autorisation qui donne à un client API un accès limité aux données utilisateur sur un serveur Web.\n\nOAuth s'appuie sur des scénarios d'authentification qui permettent au propriétaire de la ressource (utilisateur) de partager le contenu protégé du serveur hébergeant la ressource, sans partager ses informations d'identification. À cette fin, un serveur OAuth 2.0 émet des jetons d'accès que les applications clientes peuvent utiliser pour accéder aux ressources protégées au nom du propriétaire de la ressource.\n\nMoneris recommande l'utilisation d'OAuth 2.0 car il fournit des niveaux d'autorisation précis.\n", "flows": { "clientCredentials": { "tokenUrl": "/oauth2/token", "scopes": { "payment.read": "accorde un accès en lecture aux API liées au paiement", "payment.write": "accorde un accès en lecture et en écriture aux API liées au paiement", "refund.read": "accorde un accès en lecture aux remboursements", "refund.write": "accorde un accès en lecture et en écriture aux remboursements", "customer.read": "accorde un accès en lecture aux données client", "customer.write": "accorde un accès en lecture et en écriture aux données client", "kount.read": "accorde un accès en lecture aux demandes Kount", "kount.write": "accorde un accès en lecture et en écriture aux demandes Kount", "onboarding.merchant.read": "Accorde un accès en lecture aux API liées à l'intégration des commerçants", "onboarding.merchant.write": "Accorde un accès en lecture et en écriture aux API liées à l'intégration des commerçants", "onboarding.order.read": "Accorde un accès en lecture aux API liées aux commandes d'intégration", "onboarding.order.write": "Accorde un accès en lecture et en écriture aux API liées aux commandes d'intégration", "dispute.read": "Accorde un accès en lecture aux API liées aux litiges", "dispute.write": "Accorde un accès en lecture et en écriture aux API liées aux litiges", "payout.write": "Accorde un accès en lecture et en écriture aux API liées aux versements" } } } } }, "schemas": { "apiVersion": { "description": "Version de l’API du point de terminaison. \n\nDoit être fourni par le biais d’en-têtes.\n", "type": "string", "example": "2026-08-14", "default": "2026-08-14" }, "merchantId": { "type": "string", "description": "Identification de treize caractères fournie aux marchands par Moneris. \n", "minLength": 13, "maxLength": 13, "example": "0123456789101" }, "dateTime": { "type": "string", "format": "date-time", "example": "2019-07-30T06:43:40.252Z", "description": "Date & Heure" }, "paymentId": { "type": "string", "description": "Identification unique pour le paiement", "pattern": "^[A-Za-z]{2}\\d{2}[A-Za-z0-9]{26}$", "minLength": 30, "maxLength": 30, "example": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAV" }, "orderId": { "type": "string", "description": "Indique l’identifiant de transaction défini par le commerçant ou l’ID de commande. Les identifiants sont uniques pour chaque transaction d’achat, de préautorisation et de remboursement indépendant\n\n**Remarque** : Il n’est pas possible que deux transactions de ce type aient le même ID de commande.\n", "minLength": 1, "maxLength": 50, "example": "1q2w3e4r5t6t78", "pattern": "^[a-zA-Z0-9-_]+$", "nullable": true }, "invoiceNumber": { "type": "string", "description": "Envoie une valeur unique pour identifier une transaction qui est consignée par Solutions Moneris.\n", "minLength": 1, "maxLength": 17, "example": "1a2s3d45v6", "nullable": true }, "transactionDateTime": { "description": "Indique la date et l’heure de la transaction.", "type": "string", "format": "date-time", "example": "2019-07-30T06:43:40.252Z" }, "createdAt": { "description": "Heure à laquelle l’objet a été créé", "type": "string", "format": "date-time", "example": "2019-07-30T06:43:40.252Z" }, "modifiedAt": { "nullable": true, "description": "Heure à laquelle l’objet a été modifié", "type": "string", "format": "date-time", "example": "2019-07-30T06:43:40.252Z" }, "amount": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 999999999, "example": 10000, "description": "Montant" }, "currency": { "type": "string", "description": "Fournit le code monétaire à trois lettres selon la norme ISO 4217. \n\nPour obtenir la liste complète des codes de devise, rendez-vous sur : https://en.wikipedia.org/wiki/ISO_4217\n", "minLength": 3, "maxLength": 4, "example": "CAD", "format": "iso-4217" }, "subTotalAmount": { "type": "object", "description": "Sous-montant total de la transaction. \nRemarque : La valeur doit être exprimée en cents. Par conséquent, 10,59 $ doivent être envoyés en tant que 1059.\n", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "nullable": true, "required": [ "amount", "currency" ], "example": { "amount": 2000, "currency": "CAD" } }, "tipAmount": { "type": "object", "description": "Montant total du pourboire pour la transaction. \nRemarque : La valeur doit être exprimée en cents. Par conséquent, 10,59 $ doivent être envoyés en tant que 1059\n", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "nullable": true, "example": { "amount": 1200, "currency": "CAD" } }, "amountDetails": { "description": "Contient des informations relatives aux montants des sous-totaux, des pourboires et des suppléments d’un paiement.", "type": "object", "nullable": true, "properties": { "subTotalAmount": { "$ref": "#/components/schemas/subTotalAmount" }, "tipAmount": { "$ref": "#/components/schemas/tipAmount" }, "surchargeAmount": { "nullable": true, "type": "object", "description": "Montant monétaire. \nRemarque : La valeur doit être exprimée en cents. Par conséquent, 10,59 $ doivent être envoyés en tant que 1059.\n", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } } } }, "convenienceFeeDetails": { "description": "Contient des informations sur une transaction de frais de commodité.\n", "type": "object", "nullable": true, "properties": { "status": { "description": "Indique l'état des transactions de frais de commodité et de commerçant.\n", "type": "string", "nullable": true, "enum": [ "COMPLETED_CONVENIENCE_FEE_TRANSACTION", "PAYMENT_COMPLETED", "COMPLETED_VOID_TRANSACTION", "COMPLETED_REFUND_TRANSACTION", "COMPLETED_MERCHANT_INDEPENDENT_REFUND_TRANSACTION", "COMPLETED_MERCHANT_REFUND_TRANSACTION", "COMPLETED_FIRST_VOID_TRANSACTION", "PAYMENT_CANCELED" ], "example": "COMPLETED_CONVENIENCE_FEE_TRANSACTION" }, "amount": { "description": "Montant monétaire. \nRemarque : La valeur doit être exprimée en cents. Par conséquent, 10,59 $ doivent être envoyés en tant que 1059.\n", "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } }, "rate": { "description": "Taux de frais de commodité qui a été défini dans le profil du commerçant.\n", "type": "number", "format": "decimal" }, "feeType": { "description": "Type de frais de commodité qui a été défini dans le profil du commerçant. \n", "type": "string", "enum": [ "FIXED_AMOUNT", "PERCENTAGE" ] } }, "required": [ "amount", "rate", "feeType" ] }, "paymentMethodId": { "type": "string", "description": "Identifiant unique du mode de paiement.", "pattern": "^[A-Za-z]{2}\\d{2}[A-Za-z0-9]{26}$", "minLength": 30, "maxLength": 30, "example": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAV" }, "cardholderName": { "type": "string", "description": "Nom du titulaire de la carte", "minLength": 1, "maxLength": 60, "example": "John Doe" }, "firstName": { "type": "string", "description": "Prénom.", "minLength": 1, "maxLength": 30, "example": "John", "nullable": true }, "middleName": { "type": "string", "description": "Indique le deuxième prénom du client.", "minLength": 1, "maxLength": 30, "example": "J.", "nullable": true }, "lastName": { "type": "string", "description": "Nom de famille.", "minLength": 1, "maxLength": 30, "example": "Doe", "nullable": true }, "cardholderNameDetails": { "type": "object", "description": "Détails du nom du titulaire de la carte", "nullable": true, "properties": { "firstName": { "$ref": "#/components/schemas/firstName" }, "middleName": { "$ref": "#/components/schemas/middleName" }, "lastName": { "$ref": "#/components/schemas/lastName" } } }, "companyName": { "type": "string", "description": "Identifie le nom de l'entreprise associé", "minLength": 1, "maxLength": 50, "example": "SP Ltd", "nullable": true }, "cardholderInformation": { "type": "object", "description": "Informations sur le titulaire de la carte.", "nullable": true, "properties": { "cardholderName": { "$ref": "#/components/schemas/cardholderName" }, "cardholderNameDetails": { "$ref": "#/components/schemas/cardholderNameDetails" }, "companyName": { "$ref": "#/components/schemas/companyName" } }, "required": [ "cardholderName" ] }, "contactDetails": { "type": "object", "description": "Coordonnées", "nullable": true, "properties": { "phoneNumber": { "nullable": true, "type": "string", "description": "Numéro de téléphone.", "pattern": "^\\+[1-9]\\d{1,14}$", "minLength": 3, "maxLength": 16, "example": "+18663197450" }, "email": { "nullable": true, "type": "string", "format": "email", "description": "Contient l’adresse e-mail du client.\n\nPour connaître les protocoles de courrier électronique standard, consultez : https://www.rfc-editor.org/rfc/rfc5322\n", "minLength": 1, "maxLength": 320, "example": "moneris@moneris.com" } }, "example": { "phoneNumber": "+18663197450", "email": "moneris@moneris.com" } }, "expiryMonth": { "type": "integer", "format": "int32", "description": "Mois d’expiration de la carte. Le format doit être MM", "minimum": 1, "maximum": 12, "example": 1 }, "expiryYear": { "type": "integer", "format": "int32", "description": "Affiche l’année d’expiration de la carte. Format accepté : AAAA", "minimum": 2022, "maximum": 9999, "example": 2023 }, "cardBrand": { "type": "string", "description": "Affiche le nom de la marque de la carte associé au type de carte.", "enum": [ "MASTERCARD", "VISA", "AMERICAN_EXPRESS", "JCB", "DISCOVER", "INTERAC", "UNIONPAY", "GIFT_MONERIS", "GIFT_DATACANDY", "GIFT_GIVEX", null ], "nullable": true, "example": "MASTERCARD" }, "cardFingerprint": { "type": "string", "description": "Identifiant unique de la carte. \n\nL’empreinte digitale attribue de manière aléatoire des identificateurs pour les cartes qui partagent le même numéro de compte principal (PAN) afin d’identifier facilement lorsque plusieurs méthodes de paiement sont associées à la même carte sous-jacente, et aide les commerçants à identifier les clients individuels sur divers canaux. c.-à-d. programmes de fidélité.\n", "maxLength": 255, "example": "1Q2W3E4r5t6rfwewerwewrrw", "nullable": true }, "issuer": { "type": "string", "description": "L’émetteur de la carte.", "minLength": 1, "maxLength": 100, "example": "RBC", "nullable": true }, "cardInformation": { "type": "object", "description": "Informations sur la carte utilisée pour la transaction", "properties": { "bankIdentificationNumber": { "nullable": true, "type": "string", "description": "**BIN** : Numéro d’Identification de la Banque \n\nIl s’agit des six à huit premiers chiffres du numéro de compte principal (PAN) et identifie le réseau de paiement concerné et l’établissement émetteur de paiement spécifique.\n", "minLength": 6, "maxLength": 8, "example": "123456" }, "lastFour": { "nullable": true, "type": "string", "description": "Les 4 derniers chiffres de la carte.", "minLength": 4, "maxLength": 4, "example": "1234" }, "expiryMonth": { "$ref": "#/components/schemas/expiryMonth" }, "expiryYear": { "$ref": "#/components/schemas/expiryYear" }, "cardBrand": { "$ref": "#/components/schemas/cardBrand" }, "cardType": { "nullable": true, "type": "string", "description": "Spécifie l’utilisation prévue de la carte. c’est-à-dire débit ou crédit.", "enum": [ "CREDIT", "DEBIT", "DOMESTIC_DEBIT", "PREPAID_RELOADABLE", "PREPAID_NON_RELOADABLE", "UNKNOWN", "GIFT", "LOYALTY", "FLEET", "CORPORATE" ], "example": "CREDIT" }, "cardFingerprint": { "$ref": "#/components/schemas/cardFingerprint" }, "issuer": { "$ref": "#/components/schemas/issuer" } } }, "paymentAccountReference": { "type": "string", "nullable": true, "description": "Utilisé pour lier des transactions basées sur un numéro de compte principal (PAN) et des transactions sur des jetons de paiement associés sans utiliser le PAN comme mécanisme de liaison.\n", "minLength": 1, "maxLength": 29, "example": "11112222333344445555666677778" }, "storePaymentMethod": { "description": "Stockez ce mode de paiement créé par le biais de ce paiement pour une utilisation ultérieure. \n- DO_NOT_STORE : Le mode de paiement ne sera pas enregistré.\n- CARDHOLDER_INITIATED : Mode de paiement à enregistrer et ne peut être réutilisé qu’avec le consentement du titulaire de la carte. Limité au magasin, à la pré-autorisation et aux validations de carte.\n- MERCHANT_INITIATED : Mode de paiement à enregistrer et réutilisable sans le consentement du titulaire de la carte. Par exemple, les abonnements.\n", "type": "string", "default": "DO_NOT_STORE", "enum": [ "DO_NOT_STORE", "CARDHOLDER_INITIATED", "MERCHANT_INITIATED" ] }, "paymentMethodInformationBase": { "description": "Payment Method details.\n", "type": "object", "properties": { "paymentMethodType": { "type": "string", "description": "Le type de Mode de paiement utilisé. Il peut s’agir de :\n - Carte.\n - KONEK.\n", "enum": [ "CARD", "KONEK" ], "example": "CARD" }, "paymentMethodSource": { "type": "string", "description": "La source du Mode de paiement utilisé. Il peut s’agir de :\n - L’Id d’un Mode de paiement déjà créé.\n - Jeton permanent.\n - Jeton temporaire.\n - Carte.\n - Portefeuille électronique.\n - KONEK.\n", "enum": [ "CARD", "TEMPORARY_TOKEN", "PERMANENT_TOKEN", "APPLE_PAY_ENCRYPTED", "APPLE_PAY_DECRYPTED", "GOOGLE_PAY_ENCRYPTED", "GOOGLE_PAY_DECRYPTED", "KONEK" ], "example": "TEMPORARY_TOKEN" }, "paymentAccountReference": { "$ref": "#/components/schemas/paymentAccountReference" }, "storePaymentMethod": { "$ref": "#/components/schemas/storePaymentMethod" } }, "required": [ "paymentMethodType", "paymentMethodSource", "storePaymentMethod" ] }, "paymentMethodInformationCard": { "title": "Card Payment Method Information", "description": "Détails sur la carte utilisée dans le mode de paiement.", "type": "object", "allOf": [ { "type": "object", "properties": { "cardInformation": { "$ref": "#/components/schemas/cardInformation" } }, "required": [ "cardInformation" ] }, { "$ref": "#/components/schemas/paymentMethodInformationBase" } ], "required": [ "paymentMethodType" ] }, "paymentConsentId": { "type": "string", "description": "Identifiant unique du consentement de paiement dans KONEK. Attribué par KONEK.", "maxLength": 36, "example": "ada78940-643e-4d70-be14-3bbb36992095" }, "transactionReference": { "type": "string", "description": "Une valeur de référence unique pour les données de transaction.", "maxLength": 36 }, "accountType": { "type": "string", "description": "Le type de compte pour le paiement", "enum": [ "BANK_ACCOUNT_SAVINGS", "BANK_ACCOUNT_CHEQUING", "BANK_ACCOUNT_LINE_OF_CREDIT", "VISA_CREDIT", "VISA_DEBIT", "MASTERCARD_CREDIT", "MASTERCARD_DEBIT", "AMEX_CREDIT" ], "example": "BANK_ACCOUNT_SAVINGS" }, "transactionData": { "title": "transactionData", "description": "Données de transaction.", "type": "object", "properties": { "paymentToken": { "type": "string", "description": "Le jeton de paiement requis pour la demande d'autorisation de paiement. Il peut s'agir d'un Token PAN pour les cartes ou d'un jeton de paiement Interac pour ABP.", "maxLength": 19, "example": 1234007123456789000 }, "tokenExpiry": { "type": "string", "description": "La date d'expiration du jeton au format MMYY.", "maxLength": 4, "example": 1220 }, "cryptogram": { "type": "string", "description": "Le cryptogramme de paiement à utiliser avec le jeton pour une demande d'autorisation de paiement. La présence du cryptogramme dépend du `OrderItemPaymentType` et du schéma spécifié dans `paymentMethod`. Ce champ contient Amex DSCS si `paymentMethod = AMEX_CREDIT`.", "maxLength": 256, "nullable": true }, "cryptogramExpiry": { "type": "string", "description": "Date d'expiration du cryptogramme au format ISO 8601.", "format": "date-time", "nullable": true, "example": "2021-09-27T17:06:09Z" }, "consentId": { "$ref": "#/components/schemas/paymentConsentId" }, "transactionReference": { "$ref": "#/components/schemas/transactionReference" }, "konekPaymentMethod": { "$ref": "#/components/schemas/accountType" }, "amount": { "description": "Montant à utiliser pour la transaction de paiement, copié de la demande du marchand.", "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } }, "konekPaymentType": { "description": "Type de transaction, copié de la demande du marchand.", "nullable": true, "type": "string", "enum": [ "SINGLE", "SPLIT", "RECURRING" ], "example": "SINGLE" } }, "required": [ "paymentToken", "tokenExpiry", "consentId", "transactionReference", "konekPaymentMethod", "amount" ] }, "transactionTokenData": { "title": "transactionTokenData", "description": "Combine les derniers chiffres du jeton PAN et les données de transaction pour des informations de jeton de paiement améliorées.", "allOf": [ { "$ref": "#/components/schemas/transactionData" }, { "type": "object", "properties": { "tokenPrimaryAccountNumberLastDigits": { "nullable": true, "type": "string", "description": "Derniers 4 chiffres du PAN du jeton.", "maxLength": 4, "example": "3579" } } } ] }, "paymentMethodInformationKonek": { "title": "KONEK Payment Method Information", "description": "Informations sur le mode de paiement KONEK", "type": "object", "allOf": [ { "type": "object", "properties": { "konekPaymentMethodInformation": { "$ref": "#/components/schemas/transactionTokenData" } }, "required": [ "konekPaymentMethodInformation" ] }, { "$ref": "#/components/schemas/paymentMethodInformationBase" } ], "required": [ "paymentMethodType" ] }, "paymentMethodInformation": { "title": "paymentMethodInformation", "description": "Utilisé pour collecter les données de paiement nécessaires à l’exécution de la transaction. Peut également être utilisé pour collecter et enregistrer les instruments de paiement des clients dans les fichiers. \n", "oneOf": [ { "$ref": "#/components/schemas/paymentMethodInformationCard" }, { "$ref": "#/components/schemas/paymentMethodInformationKonek" } ], "discriminator": { "propertyName": "paymentMethodType", "mapping": { "CARD": "#/components/schemas/paymentMethodInformationCard", "KONEK": "#/components/schemas/paymentMethodInformationKonek" } }, "required": [ "paymentMethodType" ] }, "customData": { "description": "Le marchand peut envoyer des métadonnées personnalisées avec la transaction dans cet objet. Moneris fera écho à ces valeurs en réponse.", "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 50 }, "maxProperties": 10, "nullable": true }, "paymentMethod": { "title": "paymentMethod", "description": "Objet de réponse du moyen de paiement", "type": "object", "properties": { "paymentMethodId": { "$ref": "#/components/schemas/paymentMethodId" }, "merchantId": { "$ref": "#/components/schemas/merchantId" }, "cardholderInformation": { "$ref": "#/components/schemas/cardholderInformation" }, "contactDetails": { "$ref": "#/components/schemas/contactDetails" }, "billingAddress": { "nullable": true, "type": "object", "description": "L’adresse postale, y compris la rue, la ville, la province et le code postal.\nEn option, un numéro d’unité peut être fourni.\n", "properties": { "unitNumber": { "nullable": true, "type": "string", "description": "Numéro d’unité", "minLength": 1, "maxLength": 19, "example": "123A" }, "streetNumber": { "nullable": true, "type": "string", "description": "Numéro de rue", "minLength": 1, "maxLength": 19, "example": "3300" }, "streetName": { "nullable": true, "type": "string", "description": "Nom de la rue", "minLength": 1, "maxLength": 100, "example": "Bloor" }, "city": { "nullable": true, "type": "string", "description": "Identifie la ville.\n", "minLength": 1, "maxLength": 50, "example": "Toronto" }, "province": { "nullable": true, "type": "string", "description": "Code ISO 3166-2 de la province ou de l’État ", "minLength": 1, "maxLength": 3, "format": "iso-3166-2", "example": "ON" }, "postalCode": { "nullable": true, "type": "string", "description": "Code postal", "minLength": 1, "maxLength": 30, "example": "M8X 2X2" }, "country": { "nullable": true, "type": "string", "description": "Fournit le code de pays à deux lettres selon la norme ISO 3166-1 alpha-2. \nPour obtenir la liste complète des codes de pays, consultez le site : https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.\n", "minLength": 2, "maxLength": 2, "example": "CA", "format": "iso-3166" } }, "example": { "unitNumber": "123A", "streetNumber": "3300", "streetName": "Bloor Street West", "city": "Toronto", "province": "ON", "postalCode": "M8X 2X2", "country": "CA" } }, "paymentMethodInformation": { "$ref": "#/components/schemas/paymentMethodInformation" }, "createdAt": { "$ref": "#/components/schemas/createdAt" }, "modifiedAt": { "$ref": "#/components/schemas/modifiedAt" }, "customData": { "$ref": "#/components/schemas/customData" } }, "required": [ "paymentMethodId", "merchantId", "paymentMethodInformation", "createdAt" ] }, "paymentStatus": { "type": "string", "description": "Description de l’état du paiement.", "enum": [ "CANCELED", "DECLINED", "DECLINED_RETRY", "AUTHORIZED", "PROCESSING", "SUCCEEDED", "INCREMENTED", "PARTIALLY_COMPLETED" ], "example": "SUCCEEDED" }, "iso": { "type": "string", "description": "Représente le code de réponse de Moneris pour le code de réponse équivalent de l’Organisation internationale de normalisation (ISO).", "minLength": 2, "maxLength": 2, "example": "00" }, "responseCode": { "type": "string", "description": "\"Détails Codes de réponse des transactions :\n- **< 50** : Transaction approuvée - **> 50** : Transaction refusée\nNULL : Transaction non envoyée pour autorisation\nPour une liste complète des définitions, reportez-vous au tableau des codes de réponse.\n", "minLength": 3, "maxLength": 3, "example": "001" }, "authorizationCode": { "type": "string", "maxLength": 8, "nullable": true, "pattern": "^[a-zA-Z0-9]*$", "description": "Contient une valeur générée par l’autorisateur pour les transactions financières. \nIl s’agit de l’identification de transaction de l’hôte d’autorisation.\n", "example": "11223344" }, "message": { "type": "string", "description": "Affiche la description de la réponse renvoyée par l’établissement émetteur.\n\n**REMARQUE** : Ce message ne doit pas être affiché sur les matériaux destinés au titulaire de la carte. \n\nPour obtenir des reçus, veuillez vous référer aux Exigences en matière de reçus.\n", "minLength": 1, "maxLength": 100, "example": "SUCCESS", "nullable": true }, "ecommerceIndicator": { "type": "string", "description": "Catégorie de transaction e-commerce renvoyée par l’émetteur.\nLorsqu’elle est renvoyée dans le response, elle peut être différente de la valeur envoyée dans la demande au cas où la transaction aurait été déclassée par l’émetteur.\n", "enum": [ "MAIL_TELEPHONE_ORDER_SINGLE", "MAIL_TELEPHONE_ORDER_RECURRING", "MAIL_TELEPHONE_ORDER_INSTALMENT", "MAIL_TELEPHONE_ORDER_UNKNOWN", "AUTHENTICATED_ECOMMERCE", "NON_AUTHENTICATED_ECOMMERCE", "SSL_MERCHANT" ], "example": "AUTHENTICATED_ECOMMERCE", "default": "SSL_MERCHANT" }, "statusDetails": { "type": "object", "description": "Détails supplémentaires sur le résultat de la transaction.", "properties": { "transactionUniqueId": { "type": "string", "description": "Identifiant de transaction en temps réel de l’hôte.", "nullable": true }, "isoResponseCode": { "$ref": "#/components/schemas/iso" }, "responseCode": { "$ref": "#/components/schemas/responseCode" }, "authorizationCode": { "$ref": "#/components/schemas/authorizationCode" }, "message": { "$ref": "#/components/schemas/message" }, "ecommerceIndicator": { "$ref": "#/components/schemas/ecommerceIndicator" } }, "required": [ "isoResponseCode", "responseCode", "ecommerceIndicator" ] }, "mastercardMerchantAdviceCode": { "title": "Mastercard Merchant Advice Code", "type": "string", "nullable": true, "description": "Indique aux commerçants la raison du refus des transactions et la marche à suivre que les commerçants peuvent suivre. S'il est présent, cela contient des informations sur les raisons pour lesquelles le paiement a échoué, s'il peut être réessayé et dans certains cas, la durée recommandée après laquelle il doit être réessayé.\n", "enum": [ "NEW_ACCOUNT_INFORMATION", "TRY_AGAIN_LATER", "DO_NOT_RETRY", "TOKEN_REQUIREMENTS_NOT_FULFILLED", "NEGOTIATED_VALUES_NOT_APPROVED", "PAYMENT_CANCELLATION", "MERCHANT_NOT_QUALIFIED", "RETRY_AFTER_1_HOUR", "RETRY_AFTER_24_HOUR", "RETRY_AFTER_2_DAYS", "RETRY_AFTER_4_DAYS", "RETRY_AFTER_6_DAYS", "RETRY_AFTER_8_DAYS", "RETRY_AFTER_10_DAYS", "NON_RELOADABLE_PREPAID_CARD", "SINGLE_USE_VIRTUAL_CARD", "MULTI_USE_VIRTUAL_CARD", null ], "example": "NON_RELOADABLE_PREPAID_CARD" }, "addressVerificationServiceResultCode": { "title": "AVS Result Description", "type": "string", "nullable": true, "description": "Indique le résultat de la vérification de l’adresse. \n", "enum": [ "FULL_MATCH", "PARTIAL_MATCH", "NO_MATCH", "UNAVAILABLE", null ], "example": "FULL_MATCH" }, "cardSecurityCodeResult": { "type": "string", "nullable": true, "description": "Indique le résultat de la validation du code de sécurité de la carte.\n-**MATCH**\n- **NO_MATCH**\n- **NOT_PROCESSED**\n- **CVD_NOT_PRESENT**\n- **NOT_CVD_PRESENT**\n- **AMEX_JCB_MATCH**\n- **AMEX_JCB_INVALID**\n- **OTHER**\"\n", "enum": [ "MATCH", "NO_MATCH", "NOT_PROCESSED", "CVD_NOT_PRESENT", "NOT_CVD_PARTICIPANT", "AMEX_JCB_MATCH", "AMEX_JCB_INVALID", "OTHER", null ], "example": "MATCH" }, "threeDSecureAuthenticationValueResult": { "type": "string", "nullable": true, "description": "La valeur de vérification de l'authentification du titulaire de la carte (CAVV), la valeur d'authentification du titulaire du compte (AAV) et la valeur de vérification American Express (AEVV) sont les valeurs qui permettent à Visa, Mastercard et American Express de valider l'intégrité des données de transaction Visa Secure, Mastercard Identity Check et American Express SafeKey. Ces valeurs sont renvoyées par l'émetteur au commerçant une fois l'authentification effectuée. Le commerçant intègre ensuite la valeur CAVV/AAV/AEVV dans la demande d'autorisation à l'aide de la demande de paiement avec les données de transaction 3-D Secure.\n", "enum": [ "AMEX_AEVV_FAILED_ATTEMPT_ISSUER_KEY", "AMEX_AEVV_FAILED_ATTEMPT_ISSUER_NOT_PARTICIPATING_NETWORK_KEY", "AMEX_AEVV_FAILED_ATTEMPT_PARTICIPATING_NOT_AVAILABLE_NETWORK_KEY", "AMEX_AEVV_FAILED_AUTHENTICATION_ISSUER_KEY", "AMEX_AEVV_PASSED_ATTEMPT_ISSUER_KEY", "AMEX_AEVV_PASSED_ATTEMPT_ISSUER_NOT_PARTICIPATING_NETWORK_KEY", "AMEX_AEVV_PASSED_ATTEMPT_PARTICIPATING_NOT_AVAILABLE_NETWORK_KEY", "AMEX_AEVV_PASSED_AUTHENTICATION_ISSUER_KEY", "AMEX_AEVV_UNCHECKED", "VISA_CAVV_NOT_PRESENT_OR_NOT_VERIFIED", "MASTERCARD_AUTHENTICATION_ATTEMPTED", "MASTERCARD_AUTHENTICATION_FAILED", "MASTERCARD_AUTHENTICATION_SUCCESSFUL", "VISA_CAVV_AUTHENTICATION_RESULTS_INVALID", "VISA_CAVV_FAILED_VALIDATION_ATTEMPTED", "VISA_CAVV_FAILED_VALIDATION_AUTHENTICATION", "VISA_CAVV_NOT_VALIDATED_ISSUER_NOT_PARTICIPATING", "VISA_CAVV_PASSED_VALIDATION_ATTEMPTED", "VISA_CAVV_PASSED_VALIDATION_AUTHENTICATION", "VISA_CAVV_PASSED_VALIDATION_INFO_ONLY", "VISA_CAVV_WAS_NOT_VALIDATED_ATTEMPTED", "VISA_CAVV_WAS_NOT_VALIDATED_AUTHENTICATION", null ], "example": "VISA_CAVV_PASSED_VALIDATION_ATTEMPTED" }, "verificationDetails": { "description": "Codes de résultat pour CVD, AVS, 3DS", "type": "object", "properties": { "addressVerificationServiceResultCode": { "$ref": "#/components/schemas/addressVerificationServiceResultCode" }, "cardSecurityCodeResultCode": { "$ref": "#/components/schemas/cardSecurityCodeResult" }, "threeDSecureAuthenticationValueResultCode": { "$ref": "#/components/schemas/threeDSecureAuthenticationValueResult" } } }, "originalAmount": { "type": "object", "nullable": true, "description": "Montant initial de la première transaction de la série. \nRemarque : La valeur doit être exprimée en cents. Par conséquent, 10,59 $ doivent être envoyés en tant que 1059\n", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 15000, "currency": "CAD" } }, "issuerId": { "type": "string", "description": "Affiche un identifiant unique pour les informations d’identification stockées du titulaire de la carte. \n\nCes informations sont renvoyées par la marque de la carte lors du traitement d’une transaction d’identification enregistrée.\n", "minLength": 1, "maxLength": 15, "example": "A", "nullable": true }, "credentialOnFileResponse": { "type": "object", "nullable": true, "description": "Contient des champs liés aux informations d’identification enregistrées (CoF) ", "properties": { "originalAmount": { "$ref": "#/components/schemas/originalAmount" }, "issuerId": { "$ref": "#/components/schemas/issuerId" } } }, "money": { "type": "object", "description": "Montant monétaire. \nRemarque : La valeur doit être exprimée en cents. Par conséquent, 10,59 $ doivent être envoyés en tant que 1059.\n", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } }, "multiCurrencyPricingDetails": { "type": "object", "nullable": true, "description": "Taux de change à utiliser dans une transaction financière MCP ultérieure", "properties": { "cardholderAmount": { "$ref": "#/components/schemas/money" }, "merchantSettlementAmount": { "description": "Le montant qui sera payé au commerçant, en devise de règlement", "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } }, "multiCurrencyPricingExchangeRate": { "description": "Le taux de change étranger (devise étrangère en CAD) qui sera utilisé pour la transaction", "type": "number", "format": "decimal", "example": 1.2346 } }, "required": [ "cardholderAmount", "merchantSettlementAmount", "multiCurrencyPricingExchangeRate" ], "example": { "cardholderAmount": { "currency": "USD", "amount": 30000 }, "merchantSettlementAmount": { "currency": "CAD", "amount": 37035 }, "multiCurrencyPricingExchangeRate": 1.2345 } }, "refundId": { "type": "string", "pattern": "^[A-Za-z]{2}\\d{2}[A-Za-z0-9]{26}$", "minLength": 30, "maxLength": 30, "description": "Identification unique du remboursement", "example": "ri0105ARZ3NDEKTSV4RRFFQ69G5FAV" }, "refundUri": { "title": "Refund URI", "description": "URL de référence du remboursement.", "type": "string", "nullable": true, "format": "uri-reference", "example": "/refunds/ri0105ARZ3NDEKTSV4RRFFQ69G5FAV" }, "refundReference": { "description": "Référence du remboursement.", "type": "object", "nullable": true, "properties": { "refundId": { "$ref": "#/components/schemas/refundId" }, "href": { "$ref": "#/components/schemas/refundUri" } }, "required": [ "refundId" ] }, "refundDetails": { "description": "Les détails du remboursement, le cas échéant.", "type": "object", "nullable": true, "properties": { "refunds": { "description": "Liste des remboursements associés à ce paiement", "type": "array", "items": { "$ref": "#/components/schemas/refundReference" } }, "refundedAmount": { "$ref": "#/components/schemas/money" } }, "required": [ "refundedAmount" ] }, "subscriptionId": { "type": "string", "pattern": "^[A-Za-z]{2}\\d{2}[A-Za-z0-9]{26}$", "minLength": 30, "maxLength": 30, "description": "Identification unique de l'abonnement", "example": "si0105ARZ3NDEKTSV4RRFFQ69G5FAV" }, "subscriptionReference": { "description": "Référence de l'abonnement, si cette transaction est liée à un abonnement.", "type": "object", "nullable": true, "properties": { "subscriptionId": { "$ref": "#/components/schemas/subscriptionId" }, "href": { "nullable": true, "title": "SubscriptionUri", "description": "URL de référence de l'abonnement.", "type": "string", "format": "uri-reference", "example": "/subscriptions/rp0105ARZ3NDEKTSV4RRFFQ69G5FAV" } }, "required": [ "subscriptionId" ] }, "installmentId": { "type": "string", "description": "Identifiant généré par Visa pour un plan d'installment.", "minLength": 36, "maxLength": 36, "example": "130d93f9-8a5d-a78c-4741-14905057ce01" }, "installmentIdReference": { "type": "string", "description": "Un nom convivial lisible par l'homme, unique, alphanumérique et court généré par Visa pour le plan d'installment.", "minLength": 10, "maxLength": 10, "example": "0000000063" }, "installmentTermsAndConditionsVersion": { "type": "string", "description": "Version des conditions générales du plan de versement. Version des conditions générales acceptées par le consommateur. La version est incrémentée automatiquement chaque fois qu'une mise à jour est apportée au plan par l'émetteur.", "minLength": 1, "maxLength": 2147483647, "example": "1" }, "installmentAcceptanceId": { "type": "string", "description": "Identifiant généré par Visa pour une acceptation de plan.", "minimum": 36, "maximum": 36, "example": "56d58423-ea25-64e0-ddf3-1e1133549801" }, "installmentStatus": { "type": "string", "description": "Statut du plan de versement.", "enum": [ "ACCEPTED", "NEW", "CANCELED" ], "example": "ACCEPTED" }, "installmentPlanDetails": { "type": "object", "description": "Résultats de la demande de plan d'installment.", "nullable": true, "properties": { "planId": { "$ref": "#/components/schemas/installmentId" }, "planIdReference": { "$ref": "#/components/schemas/installmentIdReference" }, "planTermsAndConditionsVersion": { "$ref": "#/components/schemas/installmentTermsAndConditionsVersion" }, "planAcceptanceId": { "$ref": "#/components/schemas/installmentAcceptanceId" }, "planStatus": { "$ref": "#/components/schemas/installmentStatus" }, "planProcessingResponseMessage": { "nullable": true, "type": "string", "description": "Réponse de traitement du plan de versement", "minLength": 2, "maxLength": 50 } }, "required": [ "planId", "planIdReference", "planTermsAndConditionsVersion", "planAcceptanceId", "planStatus" ] }, "processedAt": { "description": "Heure à laquelle l’objet a été traité", "type": "string", "format": "date-time", "example": "2019-07-30T06:43:40.252Z" }, "incrementalAuthorization": { "description": "Objet d’autorisation incrémentale contenant le montant et l’heure de traitement.", "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/money" }, "processedAt": { "$ref": "#/components/schemas/processedAt" } }, "required": [ "amount", "processedAt" ] }, "incrementalAuthorizations": { "description": "Liste de toutes les autorisations précédentes", "type": "array", "items": { "$ref": "#/components/schemas/incrementalAuthorization" } }, "multipleCompletion": { "description": "Objet de plusieurs complétions contenant le montant, l’heure de traitement et le drapeau finalCompletion", "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/money" }, "processedAt": { "$ref": "#/components/schemas/processedAt" }, "finalCompletion": { "type": "boolean", "description": "Indique si c'est la dernière demande de finalisation pour un paiement. Pour indiquer que des finalisations supplémentaires seront effectuées, veuillez passer finalCompletion comme faux.\n" } }, "required": [ "amount", "processedAt", "finalCompletion" ] }, "multipleCompletions": { "description": "Liste de toutes les transactions de plusieurs complétions.", "type": "array", "items": { "$ref": "#/components/schemas/multipleCompletion" } }, "payment": { "title": "payment", "type": "object", "description": "Retourne un paiement traité", "properties": { "paymentId": { "$ref": "#/components/schemas/paymentId" }, "merchantId": { "$ref": "#/components/schemas/merchantId" }, "orderId": { "$ref": "#/components/schemas/orderId" }, "invoiceNumber": { "$ref": "#/components/schemas/invoiceNumber" }, "transactionDateTime": { "$ref": "#/components/schemas/transactionDateTime" }, "createdAt": { "$ref": "#/components/schemas/createdAt" }, "modifiedAt": { "$ref": "#/components/schemas/modifiedAt" }, "amount": { "description": "Ce montant ne comprend pas les frais supplémentaires, les frais de demande et les frais de commodité.", "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } }, "authorizedAmount": { "description": "Il s’agit des fonds détenus par l’autorisation sur le mode de paiement.", "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } }, "capturableAmount": { "description": "Montant restant qui peut encore être capturé.", "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "currency": { "$ref": "#/components/schemas/currency" } }, "required": [ "amount", "currency" ], "example": { "amount": 16000, "currency": "CAD" } }, "amountDetails": { "$ref": "#/components/schemas/amountDetails" }, "convenienceFeeDetails": { "$ref": "#/components/schemas/convenienceFeeDetails" }, "customerId": { "nullable": true, "type": "string", "description": "Identification unique du client", "example": "ci0105ARZ3NDEKTSV4RRFFQ69G5FAV", "pattern": "^[A-Za-z]{2}\\d{2}[A-Za-z0-9]{26}$", "minLength": 30, "maxLength": 30 }, "customerReference": { "nullable": true, "type": "string", "description": "Identification unique du client. Il peut s'agir d'un identifiant généré à partir d'un identifiant défini par le marchand.", "example": "911677-212", "minLength": 1, "maxLength": 50 }, "paymentMethod": { "$ref": "#/components/schemas/paymentMethod" }, "paymentStatus": { "$ref": "#/components/schemas/paymentStatus" }, "transactionDetails": { "description": "Additional details about the transaction outcome.", "allOf": [ { "$ref": "#/components/schemas/statusDetails" }, { "type": "object", "properties": { "mastercardMerchantAdviceCode": { "$ref": "#/components/schemas/mastercardMerchantAdviceCode" } } } ] }, "verificationDetails": { "$ref": "#/components/schemas/verificationDetails" }, "credentialOnFileResponse": { "$ref": "#/components/schemas/credentialOnFileResponse" }, "multiCurrencyPricingDetails": { "$ref": "#/components/schemas/multiCurrencyPricingDetails" }, "refundDetails": { "$ref": "#/components/schemas/refundDetails" }, "subscription": { "$ref": "#/components/schemas/subscriptionReference" }, "installmentPlanDetails": { "$ref": "#/components/schemas/installmentPlanDetails" }, "customData": { "$ref": "#/components/schemas/customData" }, "incrementalAuthorizations": { "$ref": "#/components/schemas/incrementalAuthorizations" }, "multipleCompletions": { "$ref": "#/components/schemas/multipleCompletions" } }, "required": [ "paymentId", "merchantId", "transactionDateTime", "createdAt", "amount", "authorizedAmount", "capturableAmount", "paymentMethod", "paymentStatus", "transactionDetails", "verificationDetails" ] }, "self": { "description": "Lien de pagination pointant vers la page actuelle.", "type": "string", "format": "uri-reference", "nullable": true }, "first": { "description": "Lien de pagination pointant vers la première page.", "type": "string", "format": "uri-reference", "nullable": true }, "last": { "description": "Lien de pagination pointant vers la dernière page.", "type": "string", "format": "uri-reference", "nullable": true }, "next": { "description": "Lien de pagination pointant vers la page suivante.", "type": "string", "format": "uri-reference", "nullable": true }, "previous": { "description": "Lien de pagination pointant vers la page précédente.", "type": "string", "format": "uri-reference", "nullable": true }, "paymentList": { "title": "paymentList", "type": "object", "description": "corps de la réponse, renvoie une liste paginée des paiements", "properties": { "data": { "description": "Liste des paiements.", "type": "array", "items": { "type": "object", "$ref": "#/components/schemas/payment" } }, "self": { "$ref": "#/components/schemas/self" }, "first": { "$ref": "#/components/schemas/first" }, "last": { "$ref": "#/components/schemas/last" }, "next": { "$ref": "#/components/schemas/next" }, "previous": { "$ref": "#/components/schemas/previous" } }, "required": [ "data" ] }, "parameterError": { "title": "Parameter error", "description": "Erreur liée à la propriété ou à l’en-tête de la demande.", "type": "object", "properties": { "parameterName": { "type": "string", "description": "Nom de la propriété ou de l’en-tête. Peut contenir des chemins imbriqués séparés par '.'", "example": "address.postalCode" }, "parameterValue": { "type": "string", "nullable": true, "description": "Représentation de chaîne de valeur de propriété ou d’en-tête.", "example": "MAP3J8" }, "reasonCode": { "type": "string", "description": "Raison qui a déclenché l’erreur.", "enum": [ "INVALID_FORMAT", "REQUIRED_FIELD", "INVALID_VALUE" ], "example": "INVALID_FORMAT" }, "errorMessage": { "type": "string", "description": "Description lisible de l'erreur.", "nullable": true, "example": "String 'MAP3J8' does not match the postal code pattern." } }, "required": [ "parameterName", "reasonCode" ] }, "error": { "description": "Détails de la réponse d’erreur.", "properties": { "type": { "description": "Référence d’URI qui identifie le type de problème. Idéalement, il devrait s’agir d’une URL stable pour la documentation des détails sur ce type d’erreur, mais il peut également s’agir d’un URN. Si rien ne peut être fourni, une valeur « about :blank » est renvoyée.\n", "type": "string", "format": "uri", "example": "https://api-developer.moneris.com/responsehandling" }, "title": { "description": "Un résumé court et lisible par l’homme du type de problème. Il NE DEVRAIT PAS changer d’une occurrence à l’autre du problème, sauf à des fins de localisation\n", "type": "string", "example": "INSUFFICIENT_FUNDS", "nullable": true }, "status": { "description": "il transmet le code d’état HTTP utilisé pour la commodité du consommateur.\n", "type": "integer", "format": "int32", "minimum": 100, "maximum": 505, "nullable": true }, "detail": { "description": "Un message lisible par l’homme fournissant plus de détails sur l’erreur. Pour les erreurs de carte, ces messages peuvent être affichés à vos utilisateurs.\n", "type": "string", "example": "Funds are insufficient to execute the operation.", "nullable": true }, "instance": { "description": "Référence d’URI qui identifie l’occurrence spécifique du problème. En règle générale, cela se résout en une ressource qui peut inclure plus de détails sur le problème.\n", "type": "string", "example": "/payments/12f3e0a8-1d68-2b86-dd30-4ca51bb66e10", "format": "uri-reference", "nullable": true }, "category": { "description": "Type d’erreur renvoyé. \n - `API_ERROR` : cela se produit en raison d’un problème intermittent. \n - `IDEMPOTENCY_ERROR` : la clé d’idempotence a déjà été utilisée.\n - `INVALID_REQUEST_ERROR` : les données fournies dans la demande ne sont pas valides.\n - `DECLINED_ERROR` : la transaction a été refusée par l’émetteur.\n - `UNAUTHORIZED_ERROR` : l’appelant n’est pas authentifié ou n’est pas autorisé à exécuter l’opération en cours.\n - `INTERNAL_SERVER_ERROR` : Un problème interne avec nos serveurs s’est produit.\n", "enum": [ "API_ERROR", "IDEMPOTENCY_ERROR", "INVALID_REQUEST_ERROR", "DECLINED_ERROR", "UNAUTHORIZED_ERROR", "INTERNAL_SERVER_ERROR", null ], "type": "string", "nullable": true, "example": "DECLINED_ERROR" }, "errors": { "type": "array", "description": "Liste des erreurs de validation lorsque la catégorie d’erreur est INVALID_REQUEST_ERROR.", "items": { "type": "object", "$ref": "#/components/schemas/parameterError" }, "example": [ { "parameterName": "address.postalCode", "parameterValue": "MAP3J8", "errorMessage": "address.Postal code does not match regular expression", "reasonCode": "INVALID_FORMAT" } ] } }, "title": "API Error", "type": "object", "required": [ "type" ] } }, "parameters": { "apiVersion": { "in": "header", "name": "Api-Version", "required": true, "example": "2024-09-17", "description": "Version de l’API du point de terminaison. \n\nDoit être fourni dans la section des en-têtes. \n", "schema": { "$ref": "#/components/schemas/apiVersion" } }, "correlationId": { "in": "header", "name": "X-Correlation-Id", "example": "06f1e47b-a1b5-4902-be9c-bccc506127c4", "description": "Corrèle une série de requêtes au sein d’un même flux.\n\nRemarque : Cet identifiant est généré par Moneris avec chaque demande ou réponse, s’il n’existe pas. \nLes commerçants doivent faire écho à la valeur avec chaque demande qui fait partie du flux d’appels.\n", "required": false, "schema": { "type": "string", "example": "06f1e47b-a1b5-4902-be9c-bccc506127c4" } }, "merchantId": { "in": "header", "name": "X-Merchant-Id", "example": "0123456789101", "description": "Code d’identification de treize caractères. \n\nRemarque : Ce code est fourni par Moneris et est nécessaire pour identifier le commerçant qui effectue la transaction.\n", "required": true, "schema": { "$ref": "#/components/schemas/merchantId" } }, "pageBeforeCursor": { "in": "query", "name": "cursor", "description": "Curseur de pagination pour renvoyer les éléments situés après.", "required": false, "example": "d41d8cd98f00b204e9800998ecf8427e", "schema": { "type": "string", "example": "d41d8cd98f00b204e9800998ecf8427e" } }, "pageLimit": { "in": "query", "name": "limit", "description": "Nombre maximal d’éléments à renvoyer dans la réponse.", "example": 10, "schema": { "type": "integer", "default": 10, "minimum": 1, "maximum": 20, "example": 10 } }, "createdFrom": { "name": "created_from", "in": "query", "description": "Renvoie les éléments créés après la date spécifiée, par défaut à la date actuelle à partir de 12 heures.", "required": false, "example": "2024-05-16T04:00:00Z", "schema": { "$ref": "#/components/schemas/dateTime" } }, "createdTo": { "name": "created_to", "in": "query", "description": "Renvoie les éléments créés avant la date spécifiée, jusqu’à un jour plus tôt. \n\nPar défaut, la date et l’heure actuelles ne doivent pas être postérieures de plus d’un jour à la date created_from. \n", "required": false, "example": "2024-05-16T04:00:00Z", "schema": { "$ref": "#/components/schemas/dateTime" } } }, "headers": { "apiVersion": { "description": "Version de l’API du point de terminaison.", "example": "2026-08-14", "schema": { "type": "string" } }, "correlationId": { "example": "06f1e47b-a1b5-4902-be9c-bccc506127c4", "description": "Corrèle une série de requêtes au sein d’un même flux. \n\nRemarque : Cet identifiant est généré par Moneris avec chaque demande ou réponse, s’il n’existe pas, et il est recommandé au commerçant de faire écho à la valeur. \n", "schema": { "type": "string", "example": "06f1e47b-a1b5-4902-be9c-bccc506127c4" } }, "sunset": { "example": "2025-07-30T06:43:40.252Z", "description": "Optionnel.\n\nIndique que l’URI de la ressource sera mis hors service et mis hors service à l’heure spécifiée dans le futur. \nPlus de détails sont disponibles sur [RFC 8594](https://www.rfc-editor.org/rfc/rfc8594.html)\n", "schema": { "type": "string", "format": "date-time", "example": "2025-07-30T06:43:40.252Z" } }, "rateLimitCount": { "description": "Nombre maximal de requêtes que le client peut effectuer dans cette fenêtre.", "schema": { "type": "integer", "format": "int64" }, "example": 1000 }, "rateLimitRemaining": { "description": "Le nombre de requêtes autorisées dans la fenêtre actuelle.", "schema": { "type": "integer", "format": "int64" }, "example": 0 }, "rateLimitReset": { "description": "Temps relatif en secondes lorsque la fenêtre de limite de débit sera réinitialisée.", "schema": { "type": "integer", "format": "int32" }, "example": 3600 }, "retryAfter": { "description": "Indique le temps que les clients doivent attendre avant de réessayer.", "schema": { "type": "integer", "format": "int32" }, "example": 60 } }, "responses": { "listPaymentsResponse": { "description": "Liste de tous les paiements", "headers": { "Api-Version": { "$ref": "#/components/headers/apiVersion" }, "X-Correlation-Id": { "$ref": "#/components/headers/correlationId" }, "Sunset": { "$ref": "#/components/headers/sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/rateLimitCount" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/rateLimitRemaining" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentList" }, "example": { "data": [ { "paymentId": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAV", "merchantId": "0123456789101", "orderId": "1q2w3e4r5t6t78", "invoiceNumber": "1a2s3d45v6", "transactionDateTime": "2019-07-30T06:43:40.252Z", "createdAt": "2019-07-30T06:43:40.252Z", "modifiedAt": "2019-07-30T06:43:40.252Z", "amount": { "amount": 16000, "currency": "CAD" }, "authorizedAmount": { "amount": 16000, "currency": "CAD" }, "capturableAmount": { "amount": 0, "currency": "CAD" }, "amountDetails": null, "customerId": "ci0105ARZ3NDEKTSV4RRFFQ69G5FAV", "paymentMethod": { "paymentMethodId": "pm0105ARZ3NDEKTSV4RRFFQ69G5FAV", "merchantId": "0123456789101", "cardholderInformation": null, "contactDetails": null, "billingAddress": null, "paymentMethodInformation": { "paymentMethodType": "CARD", "paymentMethodSource": "CARD", "cardInformation": { "bankIdentificationNumber": "123456", "lastFour": "1234", "expiryMonth": 1, "expiryYear": 2028, "cardBrand": "MASTERCARD", "cardType": "CREDIT", "cardFingerprint": "1Q2W3E4r5t6rfwewerwewrrw", "issuer": "RBC" }, "paymentAccountReference": "11112222333344445555666677778", "storePaymentMethod": "DO_NOT_STORE" }, "createdAt": "2019-07-30T06:43:40.252Z", "modifiedAt": null, "customData": { "property1": "string", "property2": "string" } }, "paymentStatus": "SUCCEEDED", "transactionDetails": { "transactionUniqueId": "938c2cc0dcc05f2b68c4287040cfcf71", "isoResponseCode": "00", "responseCode": "000", "message": "approved", "ecommerceIndicator": "AUTHENTICATED_ECOMMERCE", "mastercardMerchantAdviceCode": "NON_RELOADABLE_PREPAID_CARD" }, "verificationDetails": { "addressVerificationServiceResultCode": "FULL_MATCH", "cardSecurityCodeResultCode": "MATCH", "threeDSecureAuthenticationValueResultCode": "VISA_CAVV_PASSED_VALIDATION_ATTEMPTED" }, "credentialOnFileResponse": null, "refundDetails": null, "customData": { "property1": "string", "property2": "string" } }, { "paymentId": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAZ", "merchantId": "0123456789101", "orderId": "1q2w3e4r5t6t78", "invoiceNumber": "1a2s3d45v6", "transactionDateTime": "2019-07-30T06:43:40.252Z", "createdAt": "2019-07-30T06:43:40.252Z", "modifiedAt": "2019-07-30T06:43:40.252Z", "amount": { "amount": 16000, "currency": "CAD" }, "authorizedAmount": { "amount": 16000, "currency": "CAD" }, "capturableAmount": { "amount": 0, "currency": "CAD" }, "amountDetails": null, "customerId": "ci0105ARZ3NDEKTSV4RRFFQ69G5FAV", "paymentMethod": { "paymentMethodId": "pm0105ARZ3NDEKTSV4RRFFQ69G5FAV", "merchantId": "0123456789101", "cardholderInformation": null, "contactDetails": null, "billingAddress": null, "paymentMethodInformation": { "paymentMethodType": "CARD", "paymentMethodSource": "CARD", "cardInformation": { "bankIdentificationNumber": "123456", "lastFour": "1234", "expiryMonth": 1, "expiryYear": 2028, "cardBrand": "MASTERCARD", "cardType": "CREDIT", "cardFingerprint": "1Q2W3E4r5t6rfwewerwewrrw", "issuer": "RBC" }, "paymentAccountReference": "11112222333344445555666677778", "storePaymentMethod": "DO_NOT_STORE" }, "createdAt": "2019-07-30T06:43:40.252Z", "modifiedAt": null, "customData": { "property1": "string", "property2": "string" } }, "paymentStatus": "CANCELED", "transactionDetails": { "transactionUniqueId": "938c2cc0dcc05f2b68c4287040cfcf71", "isoResponseCode": "00", "responseCode": "000", "message": "approved", "ecommerceIndicator": "AUTHENTICATED_ECOMMERCE", "mastercardMerchantAdviceCode": "NON_RELOADABLE_PREPAID_CARD" }, "verificationDetails": { "addressVerificationServiceResultCode": "FULL_MATCH", "cardSecurityCodeResultCode": "MATCH", "threeDSecureAuthenticationValueResultCode": "VISA_CAVV_PASSED_VALIDATION_ATTEMPTED" }, "credentialOnFileResponse": null, "refundDetails": null, "customData": { "property1": "string", "property2": "string" } }, { "paymentId": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAX", "merchantId": "0123456789101", "orderId": "1q2w3e4r5t6t78", "invoiceNumber": "1a2s3d45v6", "transactionDateTime": "2019-07-30T06:43:40.252Z", "createdAt": "2019-07-30T06:43:40.252Z", "modifiedAt": "2019-07-30T06:43:40.252Z", "amount": { "amount": 16000, "currency": "CAD" }, "authorizedAmount": { "amount": 0, "currency": "CAD" }, "capturableAmount": { "amount": 0, "currency": "CAD" }, "amountDetails": null, "customerId": "ci0105ARZ3NDEKTSV4RRFFQ69G5FAV", "paymentMethod": { "paymentMethodId": "pm0105ARZ3NDEKTSV4RRFFQ69G5FAV", "merchantId": "0123456789101", "cardholderInformation": null, "contactDetails": null, "billingAddress": null, "paymentMethodInformation": { "paymentMethodType": "CARD", "paymentMethodSource": "CARD", "cardInformation": { "bankIdentificationNumber": "123456", "lastFour": "1234", "expiryMonth": 1, "expiryYear": 2028, "cardBrand": "MASTERCARD", "cardType": "CREDIT", "cardFingerprint": "1Q2W3E4r5t6rfwewerwewrrw", "issuer": "RBC" }, "paymentAccountReference": "11112222333344445555666677778", "storePaymentMethod": "DO_NOT_STORE" }, "createdAt": "2019-07-30T06:43:40.252Z", "modifiedAt": null, "customData": { "property1": "string", "property2": "string" } }, "paymentStatus": "DECLINED", "transactionDetails": { "transactionUniqueId": "938c2cc0dcc05f2b68c4287040cfcf71", "isoResponseCode": "43", "responseCode": "421", "message": "Stolen card, pick up.", "ecommerceIndicator": "AUTHENTICATED_ECOMMERCE", "mastercardMerchantAdviceCode": "NON_RELOADABLE_PREPAID_CARD" }, "verificationDetails": { "addressVerificationServiceResultCode": "FULL_MATCH", "cardSecurityCodeResultCode": "MATCH", "threeDSecureAuthenticationValueResultCode": "VISA_CAVV_PASSED_VALIDATION_ATTEMPTED" }, "credentialOnFileResponse": null, "refundDetails": null, "customData": { "property1": "string", "property2": "string" } } ], "self": "/payments?cursor=d41d8cd98f00b&limit=50", "first": "/payments?cursor=d41d8cd98f00b&limit=50", "last": "/payments?cursor=d41d8cd98f00b&limit=50", "next": null, "previous": null } } } }, "invalidListbadRequest": { "description": "Mauvaise demande.", "headers": { "Api-Version": { "$ref": "#/components/headers/apiVersion" }, "X-Correlation-Id": { "$ref": "#/components/headers/correlationId" }, "Sunset": { "$ref": "#/components/headers/sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/rateLimitCount" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/rateLimitRemaining" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/error" }, "examples": { "idempotency_error": { "$ref": "#/components/examples/InvalidListRequestErrorResponse" } } } } }, "unauthorized": { "description": "Non autorisé. L’utilisateur ne dispose pas d’une clé API ou d’un jeton d’accès valide.", "headers": { "Api-Version": { "$ref": "#/components/headers/apiVersion" }, "X-Correlation-Id": { "$ref": "#/components/headers/correlationId" }, "Sunset": { "$ref": "#/components/headers/sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/rateLimitCount" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/rateLimitRemaining" }, "WWW-Authenticate": { "schema": { "type": "string", "example": "Bearer, error=\"invalid_token\"" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/error" }, "example": { "type": "https://developer.moneris.com/en/More/Testing/Response%20Codes", "title": "UNAUTHORIZED_REQUEST", "status": 401, "detail": null, "instance": null, "category": "UNAUTHORIZED_ERROR", "errors": [] } } } }, "forbidden": { "description": "Interdit. L’utilisateur n’est pas autorisé à accéder à la ressource demandée.", "headers": { "Api-Version": { "$ref": "#/components/headers/apiVersion" }, "X-Correlation-Id": { "$ref": "#/components/headers/correlationId" }, "Sunset": { "$ref": "#/components/headers/sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/rateLimitCount" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/rateLimitRemaining" }, "WWW-Authenticate": { "schema": { "type": "string", "example": "Bearer, error=\"insufficient_scope\"" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/error" }, "example": { "type": "https://developer.moneris.com/en/More/Testing/Response%20Codes", "title": "FORBIDDEN_REQUEST", "status": 403, "detail": null, "instance": null, "category": "UNAUTHORIZED_ERROR", "errors": [] } } } }, "tooManyRequests": { "description": "Trop de requêtes", "headers": { "Api-Version": { "$ref": "#/components/headers/apiVersion" }, "X-Correlation-Id": { "$ref": "#/components/headers/correlationId" }, "Sunset": { "$ref": "#/components/headers/sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/rateLimitCount" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/rateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/rateLimitReset" }, "Retry-After": { "$ref": "#/components/headers/rateLimitReset" } } }, "internalServer": { "description": "Erreur inattendue.", "headers": { "Api-Version": { "$ref": "#/components/headers/apiVersion" }, "X-Correlation-Id": { "$ref": "#/components/headers/correlationId" }, "Sunset": { "$ref": "#/components/headers/sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/rateLimitCount" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/rateLimitRemaining" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/error" }, "example": { "type": "https://api-developer.moneris.com/responsehandling/", "title": "INTERNAL_SERVER_ERROR", "status": 500, "detail": null, "instance": null, "category": "INTERNAL_SERVER_ERROR", "errors": [] } } } }, "serviceUnavailable": { "description": "Service temporairement indisponible", "headers": { "Api-Version": { "$ref": "#/components/headers/apiVersion" }, "X-Correlation-Id": { "$ref": "#/components/headers/correlationId" }, "Sunset": { "$ref": "#/components/headers/sunset" }, "Retry-After": { "$ref": "#/components/headers/retryAfter" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/error" }, "example": { "type": "https://api-developer.moneris.com/responsehandling/", "title": "SERVICE_UNAVAILABLE", "status": 503, "detail": null, "instance": null, "category": "INTERNAL_SERVER_ERROR", "errors": [] } } } } }, "examples": { "InvalidListRequestErrorResponse": { "summary": "Invalid query parameter", "value": { "type": "https://developer.moneris.com/en/More/Testing/Response%20Codes", "title": "INVALID_QUERY_PARAMETER", "status": 400, "detail": null, "instance": null, "category": "INVALID_REQUEST_ERROR", "errors": [ { "parameterName": "created_from", "parameterValue": "2019/07/30", "reasonCode": "INVALID_FORMAT" } ] } } } } } ```