Web service Transaction/Update
Le Web Service REST Transaction/Update permet de modifier certaines caractéristiques d'une transaction existante :
- Modifier le montant d’une transaction (à la baisse),
- Modifier la date de remise souhaitée,
- Modifier le mode de validation (possibilité de passer de la validation manuelle à la validation automatique mais pas l’inverse).
Les transactions pouvant faire l’objet d’une modification possèdent l’un des detailedStatus suivants :
- AUTHORISED_TO_VALIDATE (A valider)
- WAITING_AUTHORISATION_TO_VALIDATE (A valider et autoriser)
- WAITING_AUTHORISATION (En attente d’autorisation)
- AUTHORISED (En attente de remise)
Plus d'infos sur les statuts, consultez : Cycle de vie d'une transaction.
Le Web Service retournera une erreur PSP_010 (Transaction not found) si la transaction a déjà été remise en banque.
Consultez les paramètres de la réponse Transaction.
Paramètres d'entrée
uuid
Référence unique de la transaction générée par la plateforme de paiement.
Format
orderId
Référence de la commande définie par le marchand. Ne prend pas en charge les caractères UTF-8.
Format
comment
Commentaire libre.
Format
orderId
Référence de la commande définie par le marchand. Ne prend pas en charge les caractères UTF-8.
Format
cardUpdate.amount
Montant du paiement dans sa plus petite unité monétaire .
Exemple: 30050 pour 30050 XPF.
Format
cardUpdate.currency
Devise du paiement. Code alphabétique en majuscule selon la norme ISO 4217 alpha-3.
Exemple: "XPF" pour le franc CFP.
Format
Valeurs possibles
Les valeurs possibles sont les suivantes:
Devise | CODIFICATION ISO 4217 | Unité fractionnaire |
---|---|---|
Franc CFP (953) | XPF | 0 |
expectedCaptureDate
Chemin: cardUpdate.expectedCaptureDate
Date de remise en banque exprimée au format ISO 8601 définit par W3C.
Format
manualValidation
Chemin: cardUpdate.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 |
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.