support
Retour à la documentation
Rechercher
Catégories
Tags
Paramètres principauxtout montrer
uuid
requis
options générales
amount
currency
resolutionMode
comment
options relatives à la méthode de paiement
transactionOptions
cardOptions
manualValidation
captureDelay
mid
Testez moi
Documentation

Web service Transaction/CancelOrRefund

L'appel aux Web Services requiert une authentification HTTP Basic Authentication. Plus d'infos : "Phase d'authentification".

POSThttps://api.scelliuspaiement.labanquepostale.fr/api-payment/V4/Transaction/CancelOrRefund

Le Web Service REST Transaction/CancelOrRefund permet de rembourser (total ou partiel si l'acquéreur le supporte) ou d'annuler une transaction.
Plus d'infos : Annuler / rembourser une transaction.

Rembourser

  • Statut requis :
    • CAPTURED (Présenté)

Vous pouvez connaître le statut d'une transaction grâce au Web Service Transaction/Get (paramètredetailedStatus).

  • Remboursement partiel :

    • Utilisez le Web Service Transaction/Refund et transmettez un montant inférieur au montant de la transaction.
    • Vous pouvez rembourser partiellement plusieurs fois une transaction, jusqu'à son remboursement total.

  • Remboursement total :

    • Utilisez le Web Service Transaction/Refund et transmettez un montant égal au montant de la transaction.

Annuler

  • Statuts requis :
    • AUTHORISED_TO_VALIDATE (A valider)
    • WAITING_AUTHORISATION_TO_VALIDATE (A valider et autoriser)
    • WAITING_AUTHORISATION (En attente d’autorisation)
    • AUTHORISED (En attente de remise)

Vous pouvez connaître le statut d'une transaction grâce au Web Service Transaction/Get (paramètredetailedStatus).

  • Annulation partielle: utilisez le Web Service Transaction/Update pour modifier le montant de la transaction.

  • Annulation totale: utilisez le Web Service Transaction/Cancel pour annuler une transaction.

Paramètres d'entrée

uuid

Référence unique de la transaction générée par la plateforme de paiement.

Format

amount

Montant du paiement dans sa plus petite unité monétaire (le centime pour l'euro).

Exemple: 30050 pour 300,50 EUR.

Format

currency

Devise du paiement. Code alphabétique en majuscule selon la norme ISO 4217 alpha-3.

Exemple: "EUR" pour l'euro.

Format

Valeurs possibles

Les valeurs possibles sont les suivantes:

Devise CODIFICATION ISO 4217 Unité fractionnaire
Dollar australien (036) AUD 2
Real du Brésil (986) BRL 2
Dollar canadien (124) CAD 2
Franc suisse (756) CHF 2
Couronne tchèque (203) CZK 2
Couronne danoise (208) DKK 2
Euro (978) EUR 2
Livre Sterling (826) GBP 2
Dollar de Hong Kong (344) HKD 2
Roupie Indienne (356) INR 2
Roupie indonésienne (360) IDR 2
Yen (392) JPY 0
Won Sud Coréen (410) KRW 0
Dinar Koweïtien (414) KWD 3
Peso mexicain (484) MXN 2
Ringgit malais (458) MYR 2
Couronne norvégienne (578) NOK 2
Zloty polonais (985) PLN 2
Leu Roumain (946) RON 2
Rouble russe (643) RUB 2
Dollar de Singapour (702) SGD 2
Couronne suédoise (752) SEK 2
Baht thailandais (764) THB 2
Lire turque (949) TRY 2
Nouveau dollar de Taïwan (901) TWD 2
Dollar des États-Unis (840) USD 2
Franc CFA (952) XOF 0

resolutionMode

Une transaction peut être autorisée et en attente de remise en banque, ou remise en banque. En fonction du status de remise, plusieurs opérations sont possibles :

Si la transaction est en attente de remise :

Dans ce cas, il est possible d'annuler la transaction. La remise en banque n'aura pas lieu. Les nouveaux status de la transaction seront :

status UNPAID
detailedStatus CANCELLED

Si la transaction est remisée :

Dans ce cas, il n'est plus possible d'annuler la transaction.

Il faut créer une nouvelle transaction de remboursement (ou refund en anglais).

Que fait réllement Transaction/CancelOrRefund :

le Web Service REST Transaction/CancelOrRefund choisit l'opération à effectuer automatiquement.

Mais il est possible de forcer le type d'opération grace au paramètre resolutionMode.

Si le champ est envoyé à vide, la valeur par défaut sera AUTO.

Valeurs possibles

Les valeurs possibles sont les suivantes:

Valeur Description Annuler Rembourser
AUTO Effectue automatiquement une annulation ou un remboursement
(valeur par défaut).		 Oui "*"
Oui "*"
CANCELLATION_ONLY Effectue une annulation.

Si la transaction est remisée, une erreur est retournée.		 Oui Non
REFUND_ONLY Effectue un remboursement.

Si la transaction n'est pas remisée, une erreur est retournée.		 Non Oui

"*" selon le statut de la transaction :

  • Transaction en attente de remise : annulation.
  • Transaction remisée : remboursement.

Pour plus de détails sur le concept de remise, consulter l'article Annuler / rembourser une transaction

Format

comment

Commentaire libre.

Format

manualValidation

Chemin: transactionOptions.cardOptions.manualValidation

Mode de validation de la transaction.

Format

Valeurs possibles

Les valeurs possibles sont les suivantes:

Valeur Description
NO Validation automatique par la plateforme de paiement.
YES Validation manuelle par le marchand.
null Configuration par défaut de la boutique retenue (paramétrable dans le Back Office Marchand).

captureDelay

Chemin: transactionOptions.cardOptions.captureDelay

Délai à appliquer à la date de capture.

Description

Indique le délai en nombre de jours avant remise en banque.

Si ce paramètre n’est pas transmis, alors la valeur par défaut définie dans le Back Office Marchand sera utilisée.

Cette dernière est paramétrable dans le Back Office Marchand par toutes les personnes dûment habilitées.

Si le délai avant remise est supérieur à 365 jours dans la requête de paiement, il est automatiquement repositionné à 365 jours.

Format

mid

Numéro de contrat commerçant. Ce champ ne peut pas être utilisé et doit être null.

Référence de la réponse

Le web service retourne l'objet suivant:

Réponse Contexte
Transaction Objet contenant les informations de la transaction.

Voir la référence de la réponse pour plus de détails.