Créer un paiement

post

https://api.sb.moneris.io/payments

Cette opération est utilisée pour initier un paiement.

Demandes récentes

Connectez-vous pour voir l'historique complet des demandes

Heure	Statut	Agent utilisateur
Récupération des demandes récentes…

Loading…

Body Params

Corps de la demande, utilisé pour initier un paiement

idempotencyKey

string

required

length between 1 and 36

Identificateur unique requis pour le traitement des demandes idempotentes.

Remarque : Moneris encourage l’utilisation de la version 4 de l’UUID dans les API comme clé d’idempotence.

orderId

string | null

^[a-zA-Z0-9-_]+$

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

Remarque : Il n’est pas possible que deux transactions de ce type aient le même ID de commande.

invoiceNumber

string | null

Envoie une valeur unique pour identifier une transaction qui est consignée par Solutions Moneris.

amount

object

required

Ce montant comprend les frais supplémentaires.

amountDetails

object | null

Contient des informations relatives aux montants des sous-totaux, des pourboires et des suppléments d’un paiement.

convenienceFee

object | null

Permet aux commerçants d'appliquer un supplément à la facture d'un client (avec son consentement) pour la commodité de pouvoir payer des biens et des services en utilisant un canal de paiement alternatif.

customerId

string | null

^[A-Za-z]{2}\d{2}[A-Za-z0-9]{26}$

L’identifiant unique du client.

customerReference

string | null

Identification unique du client. Il peut s'agir d'un identifiant généré à partir d'un identifiant défini par le marchand.

paymentMethod

required

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.

ecommerceIndicator

string

enum

Defaults to SSL_MERCHANT

Décrit la catégorie de transaction de commerce électronique en cours de traitement.

Allowed:

automaticCapture

boolean

Defaults to true

true : (Par défaut) demandera à Moneris de saisir le paiement lorsqu’il est autorisé. Cela effectue une transaction d’achat.
false : incitera Moneris à bloquer les fonds lorsque le paiement est autorisé. Cela effectue une transaction de pré-autorisation.

incrementalAuthorization

boolean

Defaults to false

Ce drapeau est utilisé pour traiter la transaction de pré-autorisation en tant qu'autorisation incrémentale.

customData

object | null

Le marchand peut envoyer des métadonnées personnalisées avec la transaction dans cet objet. Moneris fera écho à ces valeurs en réponse.

dynamicDescriptor

string | null

Description définie par le commerçant envoyée par transaction et qui apparaîtra sur le relevé de carte de crédit.

En fonction de l’émetteur de la carte, le relevé affiche généralement le descripteur dynamique ajouté au nom commercial existant du commerçant, séparé par le caractère « / ».

Remarque : La longueur combinée du nom commercial du commerçant, de la barre oblique « / » et du descripteur dynamique ne doit pas dépasser 22 caractères.

threeDSecureData

Données liées à 3-D Secure

installmentPlanInformation

object | null

Détails du plan de versement, si un plan de versement est sélectionné

multiCurrencyPricing

object | null

Multi-Currency Pricing (MCP) Taux d'information sur la demande d'information

ipv4

string | null

Protocole Internet version 4 (IPv4).

ipv6

string | null

Protocole Internet version 6 (IPv6).

Headers

Api-Version

string

required

Defaults to 2025-08-14

Version de l’API du point de terminaison.

Doit être fourni dans la section des en-têtes.

X-Correlation-Id

string

Corrèle une série de requêtes au sein d’un même flux.

Remarque : Cet identifiant est généré par Moneris avec chaque demande ou réponse, s’il n’existe pas.
Les commerçants doivent faire écho à la valeur avec chaque demande qui fait partie du flux d’appels.

X-Merchant-Id

string

required

length between 13 and 13

Code d’identification de treize caractères.

Remarque : Ce code est fourni par Moneris et est nécessaire pour identifier le commerçant qui effectue la transaction.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

201Opération de paiement créée avec succès.

400Réponse du résultat de l’opération de paiement échoué

401Non autorisé. L’utilisateur ne dispose pas d’une clé API ou d’un jeton d’accès valide.

403Interdit. L’utilisateur n’est pas autorisé à accéder à la ressource demandée.

409La 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.

422Réponse du résultat de l’opération de paiement échoué

429Trop de requêtes

500Erreur inattendue.

503Service temporairement indisponible