Opérations de maintenance
La création d'une transaction initiale n'est que la première étape du cycle de vie d'une transaction. La gestion des transactions existantes (c'est-à-dire capturer une autorisation ou effectuer un remboursement) font également partie de vos activités quotidiennes.
Utilisez nos opérations dédiées ou le Merchant Portal pour effectuer des opérations de maintenance sur les transactions existantes pour tout scénario donné.
- En fonction du statut de la transaction, différentes opérations de maintenance sont possibles. Consultez les statuts de transaction possibles pour connaître les opérations disponibles.
- Les exemples ci-dessous présentent pour chaque opération les paramètres obligatoires ou fortement recommandés. Trouvez des informations détaillées sur ces objets et propriétés dans notre documentation API.
- Vous pouvez également effectuer toutes les opérations de maintenance décrites ci-dessous via le Merchant Portal et le mode d’intégration Batch. Consultez les chapitres dédiés dans les guides respectifs pour en savoir plus :
Capturer les paiements
Si vous avez initialement traité vos transactions en mode Authorisation (avec status.Output.statusCode=5), vous devez les capturer finalement pour recevoir les fonds. Pour ce faire, utilisez l'opération CapturePayment :
{
"amount": 1000,
"isFinal": false
}
| Propriété | Description |
|---|---|
| {merchantId} | Votre compte sur notre plateforme par lequel la transaction initiale a été traitée. Ajoutez-le en tant que paramètre de chemin à l'URL du point d'entrée CapturePayment. |
| {paymentId} | Le payment.Id de la transaction initiale que notre plateforme a renvoyé dans la requête CreatePayment/GetHostedCheckout. Ajoutez-le en tant que paramètre de chemin à l'URL du point d'entrée CapturePayment. |
| amount | Le montant brut que vous souhaitez capturer pour l'autorisation originale. Si laissé vide, notre plateforme capturera le montant total initial. |
| isFinal |
Définissez si vous souhaitez clôturer la transaction pour des captures ultérieures si vous capturez seulement partiellement le montant.
Si laissé vide, la valeur par défaut est "false". |
Annuler les paiements
Si vous avez initialement traité vos transactions en mode Authorisation (avec status.Output.statusCode=5), vous pouvez les annuler pour débloquer les fonds. Pour ce faire, utilisez l'opération CancelPayment :
{
"amountOfMoney": {
"amount": 1000,
"currencyCode": "EUR"
},
"isFinal": false
}| Propriété | Description |
|---|---|
| {merchantId} | Votre compte sur notre plateforme par lequel la transaction initiale a été traitée. Ajoutez-le en tant que paramètre de chemin à l'URL du point d'entrée CancelPayment. |
| {paymentId} | Le payment.Id de la transaction initiale que notre plateforme a renvoyé dans la requête CreatePayment/GetHostedCheckout. Ajoutez-le en tant que paramètre de chemin à l'URL du point d'entrée CancelPayment. |
| order.amountOfMoney amount currencyCode |
amount : Le montant brut que vous souhaitez annuler pour l'autorisation originale. currencyCode : Le code de devise ISO 4217 pour ce montant. Si laissé vide, notre plateforme annulera le montant total initial. |
| isFinal |
Définissez si vous souhaitez clôturer la transaction pour des annulations ultérieures si vous annulez seulement partiellement le montant.
Si laissé vide, la valeur par défaut est "false". |
Rembourser les paiements
Vous pouvez rembourser les paiements traités avec succès (avec status.Output.statusCode=9). Pour ce faire, utilisez l'opération RefundPayment :
{
"amountOfMoney": {
"amount": 1000,
"currencyCode": "EUR"
}
}| Propriété | Description |
|---|---|
| {merchantId} | Votre compte sur notre plateforme par lequel la transaction initiale a été traitée. Ajoutez-le en tant que paramètre de chemin à l'URL du point d'entrée RefundPayment. |
| {paymentId} | Le payment.Id de la transaction initiale que notre plateforme a renvoyé dans la demande CreatePayment/GetHostedCheckout. Ajoutez-le en tant que paramètre de chemin à l'URL du point d'entrée RefundPayment. |
| order.amountOfMoney amount currencyCode |
amount : Le montant brut que vous souhaitez rembourser pour l'autorisation originale. currencyCode : Le code de devise ISO 4217 pour ce montant. Si laissé vide, notre plateforme remboursera le montant total initial. |