Annuler le paiement

post

https://api.sb.moneris.io/payments/{payment-id}/cancel

Annuler un paiement. Cette opération peut ne pas être possible si le paiement a été effectué.

Demandes récentes

Connectez-vous pour voir l'historique complet des demandes

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

Loading…

Path Params

payment-id

string

required

length between 30 and 30

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

L’identifiant unique du paiement

Body Params

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.

multipleCompletion

object | null

Objet de plusieurs complétions contenant le montant, l’heure de traitement et le drapeau finalCompletion

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.

reason

string | null

Raison de l’annulation du paiement.

Remarque : Il s’agit d’un champ de notation.

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

Langue

Identifiants

URL

Loading…

Réponse

Cliquez sur Essayer ! pour lancer une requête et voir la réponse ici ! Ou choisissez un exemple:

application/json

application/problem+json

*/*

200Le paiement a été annulé avec succès.

400Mauvaise demande.

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.

404Introuvable.

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.

422Échec de l’annulation de la réponse Résultat de l’opération de paiement

429Trop de requêtes

500Erreur inattendue.

503Service temporairement indisponible