--- updatedAt: 2026-08-14T03:37:47.000Z agentTools: projectIndex: https://developer.moneris.com/moneris-api/fr/llms.txt --- # Mise à jour du compte marchand partenaire Mettre à jour le compte marchand partenaire # 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)" } ], "paths": { "/partner/accounts/{account-id}": { "patch": { "description": "Mettre à jour le compte marchand partenaire", "summary": "Mise à jour du compte marchand partenaire", "parameters": [ { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/accountId" }, { "$ref": "#/components/parameters/correlationId" } ], "tags": [ "Comptes Partenaires" ], "operationId": "updateAccount", "security": [ { "OAuth2": [ "partner.account.write" ] }, { "ApiKeyAuth": [] } ], "requestBody": { "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/partnerMerchantAccountDetails" } } }, "required": true }, "responses": { "200": { "$ref": "#/components/responses/accountUpdateSuccess" }, "400": { "$ref": "#/components/responses/badRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "409": { "$ref": "#/components/responses/conflict" }, "422": { "$ref": "#/components/responses/unprocessableContent" }, "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" }, "accountId": { "type": "string", "description": "Code d'identification de treize caractères.\nRemarque : Ce code est fourni par Moneris et est requis pour identifier les comptes marchands appartenant à un partenaire.\n", "example": "0123456789101", "maxLength": 13, "minLength": 13 }, "operatingAsName": { "description": "Operating as Name for the Merchant.", "maxLength": 30, "minLength": 1, "type": "string", "example": "ABC OPS" }, "phoneNumber": { "type": "string", "description": "Numéro de téléphone.", "pattern": "^\\+[1-9]\\d{1,14}$", "minLength": 3, "maxLength": 16, "example": "+18663197450" }, "firstName": { "type": "string", "description": "Prénom.", "minLength": 1, "maxLength": 30, "example": "John", "nullable": true }, "lastName": { "type": "string", "description": "Nom de famille.", "minLength": 1, "maxLength": 30, "example": "Doe", "nullable": true }, "language": { "type": "string", "format": "iso-639", "description": "Fournit le code de langue à deux lettres selon la norme ISO 639-1. \n\nPour obtenir la liste complète des codes de langue, consultez le site : https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes.\n", "minLength": 2, "maxLength": 2, "example": "en" }, "tpaBusinessURL": { "nullable": true, "description": "Bussiness URL. URL must not include HTTPS or HTTP", "maxLength": 60, "minLength": 0, "type": "string", "example": "www.example.ca", "format": "uri" }, "tpaPhone": { "description": "Numéro de téléphone.", "maxLength": 10, "minLength": 10, "pattern": "^[0-9]*$", "type": "string", "example": "1234567890" }, "tpaExtension": { "nullable": true, "description": "Phone Extension.", "pattern": "^[0-9]*$", "type": "string", "maxLength": 4, "example": "2340" }, "tpaEmail": { "description": "Contient l’adresse e-mail du client. \n", "maxLength": 60, "minLength": 1, "type": "string", "example": "test@moneris.co", "format": "email" }, "tpaAddress": { "required": [ "streetNumber", "streetName", "city", "province", "postalCode", "country" ], "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": { "type": "string", "description": "Numéro d’unité", "minLength": 1, "maxLength": 19, "example": "123A", "nullable": true }, "streetNumber": { "type": "string", "description": "Numéro de rue", "minLength": 1, "maxLength": 60, "example": "3300", "pattern": "^[0-9]*$" }, "streetName": { "type": "string", "description": "Nom de la rue", "minLength": 1, "maxLength": 60, "example": "Bloor" }, "city": { "type": "string", "description": "Identifie la ville.\n", "minLength": 1, "maxLength": 50, "example": "Toronto" }, "province": { "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": { "type": "string", "description": "Code postal", "minLength": 1, "maxLength": 10, "example": "M8X2X2" }, "country": { "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" } }, "partnerMerchantAccountDetails": { "description": "Détails du compte marchand partenaire.", "required": [ "contactInformation", "merchantInformation" ], "type": "object", "properties": { "merchantInformation": { "description": "Informations sur le marchand.", "required": [ "customerServicePhoneNumber", "operatingAsName" ], "type": "object", "properties": { "operatingAsName": { "$ref": "#/components/schemas/operatingAsName" }, "customerServicePhoneNumber": { "$ref": "#/components/schemas/phoneNumber" } } }, "contactInformation": { "description": "Informations de contact.", "required": [ "contactTypes", "email", "firstName", "language", "lastName", "phone", "address" ], "type": "object", "properties": { "contactTypes": { "maxItems": 3, "description": "Type de contact modifié :\n* LOCATION pour le contact du lieu\n* POINT_OF_SALE pour le contact du commerçant au point de vente\n* STATEMENT pour le contact de l'état.\n", "type": "array", "example": [ "LOCATION", "POINT_OF_SALE", "STATEMENT" ], "items": { "type": "string", "enum": [ "LOCATION", "POINT_OF_SALE", "STATEMENT" ], "example": "POINT_OF_SALE" } }, "firstName": { "$ref": "#/components/schemas/firstName" }, "lastName": { "$ref": "#/components/schemas/lastName" }, "language": { "$ref": "#/components/schemas/language" }, "businessUrl": { "$ref": "#/components/schemas/tpaBusinessURL" }, "phone": { "$ref": "#/components/schemas/tpaPhone" }, "extension": { "$ref": "#/components/schemas/tpaExtension" }, "mobile": { "nullable": true, "description": "Numéro de portable.", "maxLength": 10, "minLength": 10, "pattern": "^[0-9]*$", "type": "string", "example": "1234567890" }, "email": { "$ref": "#/components/schemas/tpaEmail" }, "address": { "$ref": "#/components/schemas/tpaAddress" } } } } }, "partnerMerchantAccount": { "description": "Compte marchand appartenant à un partenaire.", "allOf": [ { "type": "object", "properties": { "accountId": { "$ref": "#/components/schemas/accountId" } }, "required": [ "accountId" ] }, { "$ref": "#/components/schemas/partnerMerchantAccountDetails" } ] }, "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" } }, "accountId": { "in": "path", "name": "account-id", "example": "0123456789101", "required": true, "description": "Code d'identification de treize caractères.\nRemarque : Ce code est fourni par Moneris et est requis pour identifier les comptes marchands appartenant à un partenaire.\n", "schema": { "$ref": "#/components/schemas/accountId" } } }, "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": { "accountUpdateSuccess": { "description": "OK", "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/partnerMerchantAccount" } } } }, "badRequest": { "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" } } } }, "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": [] } } } }, "conflict": { "description": "La demande n’a pas pu être terminée en raison d’un conflit avec l’état de la ressource ou la clé d’idempotence existante.", "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/IdempotencyRequestErrorResponse" } } } } }, "unprocessableContent": { "description": "L’API ne peut pas effectuer l’action demandée en raison d’erreurs sémantiques ou de validation métier. \n", "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" } } } }, "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": { "IdempotencyRequestErrorResponse": { "value": { "type": "https://developer.moneris.com/en/More/Testing/Response%20Codes", "title": "IDEMPOTENCY_KEY_ALREADY_EXISTS", "status": 409, "detail": null, "instance": null, "category": "IDEMPOTENCY_ERROR", "errors": [] } } } } } ```