--- updatedAt: 2026-08-14T03:37:22.000Z agentTools: projectIndex: https://developer.moneris.com/moneris-api/fr/llms.txt --- # Create Payouts Issue payouts to merchants # 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": { "/payouts": { "post": { "description": "Issue payouts to merchants", "summary": "Create Payouts", "parameters": [ { "$ref": "#/components/parameters/apiVersion" }, { "$ref": "#/components/parameters/correlationId" } ], "tags": [ "Versements" ], "operationId": "createPayouts", "security": [ { "OAuth2": [ "payout.write" ] }, { "ApiKeyAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payoutRequest" } } }, "required": true }, "responses": { "201": { "$ref": "#/components/responses/createPayoutSuccess" }, "400": { "$ref": "#/components/responses/badRequest" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/notFound" }, "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" }, "idempotencyKey": { "type": "string", "description": "Identificateur unique requis pour le traitement des demandes idempotentes. \n\nRemarque : Moneris encourage l’utilisation de la version 4 de l’UUID dans les API comme clé d’idempotence. \n", "minLength": 1, "maxLength": 36, "example": "b3e1f8c2-4d2a-4e6b-9c1a-2f3e4d5b6a7c" }, "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" }, "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" } }, "transactionType": { "description": "* CREDIT – Credit transaction\n* DEBIT – Debit transaction\n", "type": "string", "example": "CREDIT", "enum": [ "CREDIT", "DEBIT" ] }, "payoutType": { "description": "Payout Types\n* DEPOSIT – Deposits (Merchants Credit/Debit Cards transactions)\n* FEES – Fees (TPA, Moneris & Card Brand Fees)\n* DISPUTES_CREDIT – Disputes Credit\n* DISPUTES_DEBIT – Disputes Debit\n* ADJUSTMENTS – Adjustments\n", "type": "string", "example": "DEPOSIT", "enum": [ "DEPOSIT", "FEES", "DISPUTES_CREDIT", "DISPUTES_DEBIT", "ADJUSTMENTS" ] }, "payoutDescription": { "nullable": true, "description": "Payout Description.", "maxLength": 80, "type": "string", "example": "Payout Description" }, "payoutReference": { "nullable": true, "description": "Payout Reference.", "maxLength": 22, "type": "string", "example": "fund-10399" }, "payoutRequest": { "description": "Payouts request", "required": [ "payoutType", "merchantId", "amount", "transactionType", "idempotencyKey" ], "type": "object", "properties": { "idempotencyKey": { "$ref": "#/components/schemas/idempotencyKey" }, "merchantId": { "$ref": "#/components/schemas/merchantId" }, "amount": { "$ref": "#/components/schemas/money" }, "transactionType": { "$ref": "#/components/schemas/transactionType" }, "payoutType": { "$ref": "#/components/schemas/payoutType" }, "payoutDescription": { "$ref": "#/components/schemas/payoutDescription" }, "payoutReference": { "$ref": "#/components/schemas/payoutReference" } } }, "modifiedAt": { "nullable": true, "description": "Heure à laquelle l’objet a été modifié", "type": "string", "format": "date-time", "example": "2019-07-30T06:43:40.252Z" }, "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 }, "payout": { "description": "Payout object", "type": "object", "properties": { "payoutId": { "description": "Utilisé pour identifier les ressources API qui peuvent être nécessaires pour les transactions ultérieures futures ; c’est-à-dire les remboursements, les corrections, les achèvements, les annulations, etc.", "example": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAV", "type": "string", "pattern": "^[A-Za-z]{2}\\d{2}[A-Za-z0-9]{26}$", "minLength": 30, "maxLength": 30 }, "merchantId": { "$ref": "#/components/schemas/merchantId" }, "amount": { "$ref": "#/components/schemas/money" }, "transactionType": { "$ref": "#/components/schemas/transactionType" }, "payoutType": { "$ref": "#/components/schemas/payoutType" }, "payoutDescription": { "$ref": "#/components/schemas/payoutDescription" }, "payoutReference": { "$ref": "#/components/schemas/payoutReference" }, "createdAt": { "nullable": true, "description": "Heure à laquelle l’objet a été créé", "type": "string", "format": "date-time", "example": "2019-07-30T06:43:40.252Z" }, "modifiedAt": { "$ref": "#/components/schemas/modifiedAt" }, "customData": { "$ref": "#/components/schemas/customData" } }, "required": [ "payoutId", "merchantId", "amount", "transactionType", "payoutType" ] }, "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" } } }, "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": { "createPayoutSuccess": { "description": "Created", "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/payout" } } } }, "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": [] } } } }, "notFound": { "description": "Introuvable.", "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://developer.moneris.com/en/More/Testing/Response%20Codes", "title": "NOT_FOUND", "status": 404, "detail": null, "instance": "/payments/pi0105ARZ3NDEKTSV4RRFFQ69G5FAV", "category": "INVALID_REQUEST_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": [] } } } } } } } ```