Transactions
Les transactions sont des actions effectuées sur une commande. Il peut s'agir d'authentifier le payeur ou la carte, de réserver les fonds du payeur ou de transférer de l'argent entre vous et le payeur. Vous lancez une transaction dans votre système en envoyant une demande d'API à ANZ eGate, qui à son tour traite la demande et l'envoie à un prestataire de mode de paiement ou à un acquéreur concerné. Pour effectuer une opération d'API, par exemple initier une transaction, vous devez disposer du privilège requis dans votre profil de commerçant auprès de la passerelle. Pour vérifier les transactions que vous pouvez, contactez votre your payment service provider. Les réseaux de paiement sans carte ou de débit peuvent avoir un ensemble limité d'opérations d'API par rapport aux cartes de crédit.
Les sections suivantes décrivent les cas d'utilisation pour les différentes transactions par carte. Il s'agit d'exemples de demandes simples ne comportant que les champs obligatoires, utilisant un mode de paiement par carte de crédit avec les détails de la carte de crédit stockée fournis en tant que jeton. Pour plus d'exemples de demandes et de réponses, voir la collection Postman.
Transactions initiales, autonomes et ultérieures
Les transactions prises en charge sur ANZ eGate peuvent être divisées en quatre groupes, en fonction de la manière dont elles peuvent être utilisées :
- Initiales
Les transactions initiales créent une nouvelle commande et démarrent le flux de paiement pour l'instance de vente. Ces transactions nécessitent un ID de commande unique qui définit la nouvelle commande. Les types de transaction suivants peuvent être utilisés comme transactions initiales :
- INITIATE_AUTHENTICATION (Initier l'authentification)
- AUTHORIZE (Autoriser)
- DISBURSEMENT (Décaissement)
- PAY (Payer)
- VERIFY (Vérifier)
- Autonomes
Les transactions autonomes sont un type spécial de transaction initiale, utilisé lorsque la transaction initiale d'une commande est effectuée en dehors de la passerelle ou lorsque vous ne souhaitez tout simplement pas associer la transaction à une commande existante. Ces transactions sont également connues dans le secteur sous le nom de : transactions non référencées, non mises en correspondance ou non liées et ne sont pas activées par défaut en raison du risque de fraude.
Les types de transaction suivants peuvent être utilisés comme transactions autonomes :
- STANDALONE CAPTURE (Collecte autonome)
- STANDALONE REFUND (Remboursement autonome)
- Ultérieures
Les transactions ultérieures sont liées à une commande existante, car elles la modifient ou la font progresser d'une manière ou d'une autre. Ces transactions doivent être liées à une transaction initiale à l'aide de son ID de commande.
Les types de transactions suivant peuvent être utilisés comme transactions ultérieures :
- AUTHENTICATE PAYER (Authentifier le payeur)
- AUTHORIZE (Autoriser)
- CAPTURE (Collecter)
- DISBURSEMENT (Décaissement)
- PAY (Payer)
- REFERRAL (Renvoyer)
- REFUND (Rembourser)
- UPDATE AUTHORIZATION (Mettre à jour l'autorisation)
- VOID (Annuler)
- CHARGEBACK (Rétrofacturation)
- Informatives
Les transactions informatives sont créées par le processeur de paiement ou l'acquéreur pour fournir des informations supplémentaires concernant la commande.
Pour plus d'informations sur la transaction Authorize (Autoriser), voir Authorize (Autoriser).
Authorize (Autoriser)
La transaction AUTHORIZE (Autoriser) vérifie les détails de la carte de votre payeur, contrôle que le payeur a des fonds suffisants disponibles par rapport à sa ligne de crédit et tente de réserver les fonds demandés. La limite de la carte de crédit du payeur est diminuée du montant autorisé et les fonds sont réservés pour une période prédéterminée (dans la plupart des cas, 5 à 8 jours), définie par le système de cartes et les règles d'émission de la carte du payeur. Pour une autorisation réussie, la passerelle renvoie result=SUCCESS dans la réponse de la transaction.
L'autorisation ne débite pas les fonds du compte de votre payeur, mais réserve le montant total de la commande, prêt pour la transaction CAPTURE (Collecter) qui débitera la carte et transférera les fonds sur votre compte. Les transactions AUTHORIZE (Autoriser) n'apparaissent pas sur le relevé de compte du payeur, contrairement aux transactions CAPTURE (Collecter).
De nombreux systèmes de banque en ligne fournissent désormais des notifications de l'activité d'autorisation.
Une transaction AUTHORIZE (Autoriser) peut être une transaction initiale (sans transaction préalable associée) ou une transaction ultérieure suite à une transaction VERIFY (Vérifier) ou AUTHENTICATE_PAYER (Authentifier le payeur). Dans ce dernier cas, les détails de la carte dans les demandes VERIFY (Vérifier) ou AUTHENTICATE_PAYER (Authentifier le payeur) doivent correspondre à la demande AUTHORIZE (Autoriser).
Si vous devez collecter un montant supérieur à celui que vous avez autorisé, ou si vous devez collecter une autorisation que vous avez effectuée en dehors de la passerelle, voir Utiliser les collectes excessives et Standalone Capture (Collecte autonome), respectivement.
| URL | https://anzegate.gateway.mastercard.com/api/rest/version/72/merchant/<merchant_ID>/order/<order_ID>/transaction/<transaction_ID> |
| Méthode HTTP | PUT |
{
"apiOperation": "AUTHORIZE",
"order": {
"amount": "100.00",
"currency": "EUR"
},
"sourceOfFunds": {
"token": "<token>"
}
}
Définir la garantie de la commande
Vous pouvez indiquer un niveau de garantie pour le montant d'autorisation à collecter en renseignant le champ order.certainty dans la demande AUTHORIZE (Autoriser). Pour ce faire, le privilège Modifier la garantie de commande doit être activé par votre your payment service provider sur votre profil de commerçant. Vous pouvez définir le champ avec l'une des valeurs suivantes :
- Final
Montant autorisé complet devant être collecté à l'aide d'une ou de plusieurs collectes dans le délai fixé (généralement, 7 jours). La commande ne sera annulée que dans des circonstances exceptionnelles (par exemple, le payeur a annulé son achat). En renseignant cette valeur sur votre transaction, vous pouvez qualifier la transaction pour des frais de traitement inférieurs.
- Estimé
Le montant autorisé est une estimation du montant à collecter dans le délai prescrit (généralement 30 à 31 jours). Il est possible que le montant collecté soit inférieur ou ne soit pas collecté du tout, ou que l'autorisation soit annulée. Le fait d'indiquer cette valeur sur votre transaction peut entraîner des frais de traitement supérieurs.
Si vous ne disposez pas du privilège de modification de la garantie de commande et si la valeur fournie dans ce champ ne correspond pas à la valeur de garantie de commande par défaut configurée sur votre profil de commerçant, la demande est rejetée.
Annuler les autorisations
La passerelle peut annuler les montants d'autorisation en suspens pour les autorisations non collectées, partiellement collectées ou expirées, lorsqu'elles sont prises en charge pour l'acquéreur. Cela vous permet de vous conformer aux exigences du système de cartes pour les annulations totales et partielles.
- Autorisations non collectées
Si vous ne souhaitez pas collecter le montant autorisé après avoir soumis une demande AUTHORIZE (Autoriser), vous devez annuler votre autorisation en soumettant une demande VOID (Annuler). Indiquez l'ID de transaction pour l'autorisation à annuler dans le champ
transaction.targetTransactionId. - Autorisations partiellement collectées
Lorsque vous soumettez une demande CAPTURE (Collecter) pour une commande, vous pouvez fournir un montant pour la demande CAPTURE (Collecter) inférieur au montant autorisé pour la commande
(order.AuthorizedAmount)défini dans votre demande AUTHORIZE (Autoriser). Si vous n'avez pas l'intention de collecter le montant autorisé restant, vous pouvez annuler le montant autorisé en suspens, lorsque cela est pris en charge par votre acquéreur. - Soumettez une demande VOID (Annuler) avec l'ID de transaction pour la transaction AUTHORIZE (Autoriser) à annuler dans le champ
transaction.targetTransactionId. - Vous pouvez indiquer le nombre prévu de collectes pour la commande dans le champ
order.expectedNumberOfCapturesdans la demande CAPTURE (Collecter) ou via l'UI Merchant Administration. Dans l'éventualité où le nombre total de collectes pour la commande (y compris la collecte en cours) est supérieur ou égal au nombre total prévu de demandes CAPTURE (Collecter), la passerelle déclenche automatiquement une transaction VOID (Annuler) du montant autorisé en suspens, lorsque cela est pris en charge par votre acquéreur. Pour autoriser le déclenchement automatique, vous devez avoir activé le privilège Annuler automatiquement les montants d'autorisation en suspens sur votre profil de commerçant par votre your payment service provider. - Autorisations expirées
- Tente automatiquement d'annuler l'autorisation et de retourner les fonds au payeur (lorsque pris en charge pour l'acquéreur). Pour ce faire, le privilège Annuler automatiquement les autorisations expirées doit être activé par votre your payment service provider sur votre profil de commerçant.
Si la commande est partiellement collectée et si votre acquéreur prend en charge l'annulation d'autorisations pour les collectes partielles, la passerelle essaie d'annuler le montant d'autorisation en suspens.
- Rejette toute demande Capture (Collecter) par rapport à la commande.
- Mise à jour des autorisations
- Différer des autorisations
- Si vous êtes un commerçant acceptant les paiements par carte sur un terminal de point de vente où le système d'autorisation du point de vente est hors ligne.
- Si vous êtes un commerçant qui accepte des paiements par téléphone et que le système d'autorisation du point de vente n'est pas en ligne.
Vous pouvez tenter d'annuler le montant de l'autorisation en suspens de deux manières :
Par exemple, si vous fournissez order.expectedNumberOfCaptures = 2 dans la première demande CAPTURE (Collecter), la passerelle annule automatiquement le montant autorisé restant lors du traitement de la deuxième demande CAPTURE (Collecter).
Si vous diminuez le nombre prévu de collectes dans les demandes CAPTURE (Collecter) suivantes (par exemple, vous mettez à jour order.expectedNumberOfCaptures = 1 =1 dans la deuxième demande CAPTURE [Collecter]), la passerelle annule automatiquement le montant autorisé restant lors du traitement de la deuxième demande CAPTURE (Collecter). En effet, 2 (nombre total de transactions CAPTURE (Collecter) pour la commande, y compris la transaction CAPTURE (Collecter) actuelle) est supérieur à 1 (nombre attendu de transactions CAPTURE (Collecter)). Cependant, si vous augmentez le nombre prévu de collectes dans les demandes Capture (Collecter) suivantes (par exemple, vous mettez à jour order.expectedNumberOfCaptures = 3 = 3 dans la deuxième demande Capture [Collecter]), la passerelle n'annulera pas le montant en suspens jusqu'à la réception de la troisième demande Capture (Collecter).
Les autorisations ont une période de validité, après laquelle elles expirent. La période de validité de l'autorisation peut être configurée sur la passerelle pour une combinaison de l'acquéreur, du type de carte et de la garantie de commande.
Lorsque vous soumettez une demande Authorize (Autoriser) à la passerelle, celle-ci détermine la date et l'heure d'expiration de l'autorisation en fonction de la période de validité de l'autorisation configurée (à l'aide de la combinaison de l'acquéreur, du type de carte et de la garantie de commande). En cas de prise en charge pour l'acquéreur, l'expiration de l'autorisation est retournée dans le champ authorizationResponse.autoExpiry de la réponse de l'opération Retrieve Transaction (Extraire la transaction). Ce champ contient la date et l'heure auxquelles la passerelle détermine automatiquement l'expiration de l'autorisation.
Une fois la période de validité de l'autorisation expirée, la passerelle :
La passerelle vous permet de prolonger la période d'autorisation et éventuellement d'augmenter ou de diminuer le montant de l'autorisation pour les autorisations valides, si cela est pris en charge pour l'acquéreur. Pour ce faire, le privilège Mettre à jour l'autorisation doit être activé par votre your payment service provider sur votre profil de commerçant. Pour plus d'informations, voir Update Authorization (Mettre à jour l'autorisation).
Vous pouvez différer une autorisation si vous n'êtes pas en mesure de soumettre une transaction AUTHORIZE (Autoriser) ou PAY (Pay) au moment où elle a été complétée avec le payeur. L'échec peut être dû à des problèmes de connectivité ou de système, ou à d'autres limitations qui vous obligent à soumettre l'autorisation en aval lorsque le système est de nouveau en ligne. L'identification des autorisations différées est obligatoire pour vous conformer aux exigences du système Visa.
Vous trouverez ci-dessous différents scénarios dans lesquels vous devez indiquer l'autorisation en tant qu'autorisation différée pour des paiements par carte Visa :
Pour différer une autorisation, indiquez le champ transaction.deferredAuthorization dans la demande AUTHORIZE (Autoriser), PAY (Payer) ou STANDALONE CAPTURE (Collecte autonome) et définissez sa valeur sur TRUE. Si vous ne renseignez pas ce champ, la valeur par défaut est FALSE.
Capture (Collecter)
La transaction Capture (Collecter) (également appelée « facture » ou « complète ») utilise l'autorisation obtenue après l'opération initiale AUTHORIZE (Autoriser) pour transférer des fonds du compte du payeur vers votre compte. Une transaction CAPTURE (Collecter) doit toujours être précédée d'une autorisation réussie. La devise utilisée lors de la collecte d'un montant doit correspondre à celle utilisée dans la transaction Autorize (Autoriser).
Les collectes sont normalement regroupées par la passerelle ou par l'hôte de l'acquéreur, de sorte que les fonds ne sont effectivement transférés qu'une fois le batch clôturé et le règlement effectué.
| URL | https://anzegate.gateway.mastercard.com/api/rest/version/72/merchant/<merchant_ID>/order/<order_ID>/transaction/<transaction_ID> |
| Méthode HTTP | PUT |
{
"apiOperation": "CAPTURE",
"transaction": {
"amount": "100.00",
"currency": "EUR"
}
}
Pour collecter une autorisation effectuée en dehors de la passerelle, voir Standalone Capture (Collecte autonome).
Utiliser des collectes excessives
Le montant total que vous collectez peut dépasser le montant initialement autorisé si le privilège Effectuer des collectes excessives est activé sur votre profil de commerçant.
La collecte excessive est une variante de la transaction CAPTURE (Collecter) où vous effectuez une collecte pour un montant supérieur au montant autorisé. Le dépassement autorisé est spécifié sous forme de pourcentage du montant initialement autorisé, et est déterminé par votre your payment service provider.
Lorsque vous soumettez une demande CAPTURE excessive, la passerelle tente automatiquement de mettre à jour le montant de l'autorisation au montant que vous souhaitez collecter. Si l'acquéreur prend en charge la mise à jour des autorisations, la passerelle lui soumet une demande Update Authorization (Mettre à jour l'autorisation). Dans le cas contraire, la passerelle approuve automatiquement une mise à jour d'autorisation (jusqu'à la limite de collecte excessive configurée pour votre profil de commerçant).
Si vous ne souhaitez pas que la passerelle tente de mettre à jour l'autorisation avant de soumettre la collecte à l'acquéreur, définissez le champ transaction.authorizationAjustmentAction avec la valeur NO_ACTION dans la demande.
Chargeback (Rétrofacturation)
Une transaction CHARGEBACK (Rétrofacturation) a lieu lorsqu'un payeur conteste un paiement qui vous a été effectué. Par exemple, les marchandises n'ont pas été reçues ou le payeur n'a pas autorisé le paiement qui vous a été fait. Votre Your payment service provider peut choisir d'importer les détails des transactions Chargeback (Rétrofacturation) sur la passerelle afin que vous les ayez à disposition pour toute recherche et génération de rapports. Votre Your payment service provider peut choisir d'enregistrer chaque transaction Chargeback (Rétrofacturation) par rapport à la commande d'origine ou de créer une nouvelle commande avec une transaction Chargeback (Rétrofacturation) distincte.
- Si vous partagez votre numéro SE ou votre ID de commerçant bancaire (l'identifiant qui vous a été attribué par votre banque acquéreuse) sur plusieurs profils de commerçant, une transaction de rétrofacturation autonome est créée pour chaque profil.
- La passerelle enregistre les transactions Chargeback (Rétrofacturation) à des fins d'information uniquement : la transaction n'est pas envoyée à l'acquéreur pour traitement en aval.
La passerelle peut créer plusieurs transactions Chargeback (Rétrofacturation) pour une même commande. Vous pouvez effectuer d'autres transactions sur une commande comportant une transaction Chargeback (Rétrofacturation), par exemple des annulations ou des remboursements.
Une transaction CHARGEBACK (Rétrofacturation) enregistrée avec succès renvoie les champs suivants dans les réponses des transactions RETRIEVE TRANSACTION (Extraire la transaction) et RETRIEVE ORDER (Extraire la commande) :
- order.status
Lorsqu'une transaction Chargeback (Rétrofacturation) est créée, le statut de la commande correspondante est mis à jour pour indiquer qu'un litige a été soulevé par le payeur.
- order.status
DISPUTED indique qu'un litige a été soulevé mais qu'aucun fonds n'a encore été déplacé.
- order.status
CHARGEBACK_PROCESSED indique qu'une demande de rétrofacturation est traitée et que les fonds seront transférés depuis ou vers le compte de commerçant.
- order.status
- order.chargeback.amount - Montant de la rétrofacturation.
- order.chargeback.currency - Devise de rétrofacturation.
- transaction.dispute object - Informations sur le litige de rétrofacturation, par exemple l'événement et la date du litige.
- transaction.type - CHARGEBACK
- transaction.source - SERVICE_PROVIDER
- gatewayEntryPoint - SERVICE_PROVIDER_API
Disbursement (Décaissement)
Avec la transaction DISBURSEMENT (Décaissement), vous pouvez envoyer des fonds sur le compte de la carte d'un payeur, par exemple pour des gains de jeux ou de paris ou pour payer la facture d'une carte de crédit d'un payeur.
Dans une demande DISBURSEMENT (Décaissement), les détails de facturation et d'expédition du payeur ne sont pas requis et la validation du cryptogramme visuel de la carte (CSC) ne s'applique pas.
Une transaction DISBURSEMENT (Décaissement) peut être une transaction initiale (sans transaction préalable associée) ou une transaction ultérieure suite à une transaction VERIFY (Vérifier) utilisée pour vérifier les détails du compte du payeur.
| URL | https://anzegate.gateway.mastercard.com/api/rest/version/72/merchant/<merchant_ID>/order/<order_ID>/transaction/<transaction_ID> |
| Méthode HTTP | PUT |
{
"apiOperation": "DISBURSEMENT",
"disbursementType": "GAMING_WINNINGS",
"order": {
"amount": "100.00",
"currency": "EUR"
},
"sourceOfFunds": {
"token": "<token>"
}
}
Pay (Payer)
La transaction PAY (Payer) (également appelée « achat » ou « vente ») combine une transaction AUTHORIZE (Autoriser) et une transaction Capture (Collecter) en un seul message. Une seule transaction autorise le paiement et transfère les fonds du compte de votre payeur vers votre compte en une seule fois. Vous pouvez fournir un indicateur dans la demande PAY (Payer) pour différer l'autorisation. Pour plus d'informations, voir la rubrique Différer les autorisations.
Une transaction PAY (Payer) peut être une transaction initiale (sans transaction préalable associée) ou une transaction ultérieure suite à une transaction VERIFY utilisée pour vérifier les détails du compte du payeur. Dans ce dernier cas, les détails de la carte dans les demandes VERIFY (Vérifier) et PAY (Payer) doivent correspondre.
Le niveau de garantie de commande pour une transaction Pay (Payer) est défini avec la valeur FINAL. Pour plus d'informations, voir Définition de la garantie de commande.
| URL | https://anzegate.gateway.mastercard.com/api/rest/version/72/merchant/<merchant_ID>/order/<order_ID>/transaction/<transaction_ID> |
| Méthode HTTP | PUT |
{
"apiOperation": "PAY",
"order": {
"amount": "100.00",
"currency": "EUR"
},
"sourceOfFunds": {
"token": "<token>"
}
}
Utiliser la collecte automatique
La collecte automatique est une variante de la transaction PAY (Payer) qui permet à un commerçant d'effectuer une transaction PAY (Payer) avec un acquéreur qui ne prend en charge que les transactions AUTHORIZE (Autoriser) et CAPTURE (Collecter) Lorsque la passerelle reçoit une demande PAY (Payer) et détermine que l'acquéreur ne la prend pas en charge, la passerelle transforme automatiquement la demande PAY (Payer) en une demande AUTHORIZE (Autoriser), suivie d'une transaction CAPTURE (Collecter) déclenchée automatiquement.
Pour ce faire, le privilège PAY (Payer) doit être activé sur votre profil de commerçant par votre your payment service provider. L'identifiant de transaction pour les demandes AUTHORIZE (Autoriser) et CAPTURE (Collecter) est l'identifiant de transaction fourni par vous dans la demande PAY (Payer) d'origine. Dans la réponse PAY (Payer), le champ transaction.type indique la dernière transaction tentée pour répondre à la demande ((AUTHORIZE (Autoriser) ou CAPTURE (Collecter)).
Vous pouvez utiliser l'opération RETRIEVE TRANSACTION (Extraire la transaction) pour récupérer les résultats d'une collecte automatique. Le résultat de la dernière transaction tentée pour répondre à la demande est renvoyé.
Vous pouvez annuler une transaction PAY (Payer) collectée automatiquement à l'aide de la transaction VOID (Annuler). Lorsque vous envoyez une demande VOID (Annuler) pour une collecte automatique, la passerelle :
- Tente une transaction VOID (Annuler) pour la transaction CAPTURE (Collecter).
- Si la première transaction VOID (Annuler) réussit, une deuxième transaction VOID (Annuler) est tenté pour la transaction AUTHORIZATION (Autorisation). Si la première transaction VOID (Annuler) échoue, la réponse indique que la transaction VOID (Annuler) a échoué et qu'aucune autre transaction VOID (Annuler) n'est tentée.
Referral (Renvoyer)
La transaction REFERRAL (Renvoyer) est nécessaire lorsqu'une transaction AUTHORIZE (Autoriser) ou PAY (Payer) échoue avec une réponse de l'acquéreur Renvoyer à l'émetteur (fournie dans le champ response.gatewaycode de la réponse).
Le payeur peut être tenu de fournir des informations supplémentaires afin que l'émetteur puisse approuver la transaction et fournir un code d'autorisation ou un identifiant d'autorisation manuel.
Utilisez la transaction Referral (Renvoyer) pour soumettre à nouveau la transaction initiale renvoyée en tant que nouvelle transaction AUTHORIZE (Autoriser) ou PAY (Payer) avec un code d'autorisation obtenu auprès de l'émetteur.
| URL | https://anzegate.gateway.mastercard.com/api/rest/version/72/merchant/<merchant_ID>/order/<order_ID>/transaction/<transaction_ID> |
| Méthode HTTP | PUT |
{
"apiOperation": "REFERRAL",
"transaction": {
"authorizationCode": "123456"
}
}
Refund (Rembourser)
Avec la transaction REFUND (Rembourser), vous pouvez recréditer les fonds d'une commande existante sur le compte du payeur si, par exemple, il renvoie des marchandises non désirées, incorrectes ou défectueuses. Les remboursements ne peuvent être effectués que lorsqu'un transfert de fonds est réalisé par le biais d'une transaction PAY (Payer), CAPTURE (Collecter) ou STANDALONE CAPTURE (Collecte autonome).
Vous pouvez effectuer un nombre quelconque de transactions REFUND (Rembourser) sur la transaction initiale, mais vous ne pouvez pas rembourser plus que le montant total obtenu par les transactions PAY (Payer) ou CAPTURE (Collecter) associées à la commande.
| URL | https://anzegate.gateway.mastercard.com/api/rest/version/72/merchant/<merchant_ID>/order/<order_ID>/transaction/<transaction_ID> |
| Méthode HTTP | PUT |
{
"apiOperation": "REFUND",
"transaction": {
"amount": "100.00",
"currency": "EUR"
}
}
Utiliser une autorisation de remboursement
Avant de soumettre votre demande Refund (Rembourser) à l'acquéreur pour compensation et règlement, la passerelle tente automatiquement et par défaut d'autoriser votre remboursement auprès de l'émetteur (lorsque pris en charge par l'acquéreur). Cela permet aux émetteurs de vérifier les détails de la carte fournis dans la demande Refund (Rembourser) afin de s'assurer du succès du remboursement.
L'autorisation de remboursement est effectuée en ligne et retourne une réponse en temps réel. Cela présente de nombreux avantages :
- Les émetteurs de cartes vous informent immédiatement si le remboursement ne peut être effectué et vous pouvez prendre les mesures qui s'imposent. Par exemple, si la carte utilisée pour la transaction de REFUND (Rembourser) n'est plus valide, l'émetteur rejette l'autorisation de remboursement. Vous pouvez contacter le payeur pour organiser un remboursement via un autre instrument de paiement.
- L'émetteur de la carte reçoit immédiatement une notification de la demande de remboursement, ce qui lui permet d'afficher instantanément les informations sur le remboursement au payeur. Cela lui permet également de gérer efficacement les requêtes/réclamations des payeurs.
Si vous ne souhaitez pas que la passerelle soumette des demandes d'autorisation pour les transactions REFUND (Rembourser), contactez votre your payment service provider pour activer le privilège Activer les remboursements sans autorisations. Même si ce privilège est activé, vous pouvez demander une autorisation pour un remboursement spécifique en attribuant la valeur true au champ action.refundAuthorization dans la demande REFUND (Rembourser).
Si l'autorisation de remboursement réussit, la passerelle procède au remboursement. Le résultat de la transaction REFUND (Rembourser) est renvoyé dans la réponse. Vous pouvez consulter le code d'autorisation reçu de l'émetteur dans Merchant Administration.
Rembourser une collecte spécifique
Si plusieurs collectes sont effectuées pour une même commande, vous devez identifier les collectes à rembourser lorsque vous remboursez tout ou partie de la commande :
- Pour rembourser une collecte spécifique dans Merchant Administration, sélectionnez la collecte ciblée dans la rubrique Remboursement et saisissez le montant du remboursement. Si la commande comporte plusieurs collecte, une nouvelle fenêtre d'interface utilisateur s'affiche pour vous permettre de sélectionner la collecte à rembourser.
- Pour rembourser une collecte spécifique à l'aide d'une demande d'API, incluez le champ transaction.targetTransactionld dans la demande afin d'identifier la collecte spécifique à rembourser et définissez-le comme ID la transaction de la demande CAPTURE (Collecter) applicable.
Utiliser les remboursements excessifs
Le montant total remboursé pour une commande peut dépasser le montant collecté avec succès, si le privilège Effectuer des remboursements excessifs est activé dans votre profil de commerçant.
Le dépassement autorisé par rapport au montant collecté pour les transactions d'API peut être configuré pour chaque devise sur la page Admin > Paramètres d'intégration dans Merchant Administration. Si vous ne définissez pas de limite de remboursement excessif pour une devise, les remboursements excessifs pour les commandes passées dans cette devise sont rejetés.
Lorsque vous soumettez une opération Refund (Rembourser), le montant total remboursé pour la commande (y compris la tentative de remboursement) ne doit pas dépasser le montant total collecté pour cette commande de plus du dépassement maximal autorisé. Par exemple, si vous soumettez un remboursement excessif via l'API pour une commande dont le montant total collecté est de 100 USD et que vous avez fixé la limite de remboursement excessif pour les transactions API à 20 USD, vous pouvez rembourser jusqu'à 120 USD.
Standalone Capture (Collecte autonome)
Une transaction STANDALONE CAPTURE (Collecte autonome) est une transaction CAPTURE (Collecter) pour laquelle l'autorisation a été effectuée en dehors de la passerelle. Lorsque vous soumettez une demande STANDALONE CAPTURE (Collecte autonome) à la passerelle, vous devez fournir le code d'autorisation généré en externe dans le champ transaction.authorizationCode. Vous devez également fournir tous les détails de la carte que vous auriez normalement fournis comme champs obligatoires dans une transaction AUTHORIZATION (Autorisation), car la passerelle ne dispose pas encore de ces informations en raison de l'autorisation externe.
Vous pouvez soumettre une transaction STANDALONE CAPTURE (Collecte autonome) si le privilège Effectuer les collectes autonomes est activé sur votre profil de commerçant.
Si vous devez collecter un montant supérieur à celui que vous avez autorisé, voir Utiliser les collectes excessives.
Vous pouvez fournir un indicateur dans la demande STANDALONE CAPTURE (Collecte autonome) pour indiquer que l'autorisation externe est une autorisation différée, lorsque cela est nécessaire. Pour plus d'informations, voir la rubrique Différer les autorisations.
| URL | https://anzegate.gateway.mastercard.com/api/rest/version/72/merchant/<merchant_ID>/order/<order_ID>/transaction/<transaction_ID> |
| Méthode HTTP | PUT |
{
"apiOperation": "CAPTURE",
"order": {
"amount": "100.00",
"currency": "EUR"
},
"sourceOfFunds": {
"token": "<token>"
},
"transaction": {
"authorizationCode": "123456",
"amount": "100.00",
"currency": "EUR"
},
}
Standalone Refund (Remboursement autonome)
Une transaction STANDALONE REFUND (Remboursement autonome) est une transaction REFUND (Rembourser) qui vous permet de transférer des fonds de votre compte au payeur, sans achat préalable. Vous pouvez utiliser une transaction STANDALONE REFUND (Remboursement autonome) lorsque vous souhaitez créditer le compte du payeur sans associer ce crédit à une transaction précédente.
| URL | https://anzegate.gateway.mastercard.com/api/rest/version/72/merchant/<merchant_ID>/order/<order_ID>/transaction/<transaction_ID> |
| Méthode HTTP | PUT |
{
"apiOperation": "REFUND",
"sourceOfFunds": {
"token": "<token>"
},
"transaction": {
"amount": "100.00",
"currency": "EUR"
}
}
UPDATE AUTHORIZATION (Mettre à jour l'autorisation)
La transaction UPDATE AUTHORIZATION (Mettre à jour l'autorisation) vous permet de ;
- Prolonger la période de validité d'une autorisation existante.
- Augmenter ou diminuer éventuellement le montant de l'autorisation.
Si vous souhaitez uniquement prolonger la période d'autorisation, ne soumettez pas le champ transaction.amount dans la demande. La date et l'heure d'expiration de l'autorisation mises à jour sont renvoyées dans le champ authorizationResponse.autoExpiry de la réponse RETRIEVE TRANSACTION (Extraire la transaction).
Si vous indiquez un montant de transaction supérieur au montant de l'autorisation existante, le montant de l'autorisation est mis à jour avec le nouveau montant. Par exemple, si le montant de l'autorisation existante est de 100 USD et vous indiquez 120 USD comme montant de la transaction dans la demande UPDATE AUTHORIZATION (Mettre à jour l'autorisation), le nouveau montant d'autorisation disponible pour collecte sera de 120 USD.
Si vous indiquez un montant de transaction inférieur au montant de l'autorisation existante, le montant de l'autorisation est mis à jour avec le nouveau montant. Par exemple, si le montant de l'autorisation existante est de 100 USD et vous indiquez 80 USD comme montant de la transaction dans la demande UPDATE AUTHORIZATION (Mettre à jour l'autorisation), le nouveau montant d'autorisation disponible pour collecte sera de 80 USD. La passerelle traite automatiquement une demande d'annulation pour le montant d'autorisation restant de 20 USD (si cette option est prise en charge pour l'acquéreur).
La passerelle ne peut mettre à jour une autorisation existante que si les conditions suivantes sont satisfaites :
- Le privilège Mettre à jour l'autorisation doit être activé par votre your payment service provider sur votre profil de commerçant sur la passerelle.
- La devise de la commande doit correspondre à celle figurant sur l'autorisation existante.
- L'autorisation existante doit être valide, réussie et entièrement approuvée.
- Pour les transactions Mastercard, l'augmentation du montant de l'autorisation prolonge automatiquement la période de validité de l'autorisation. Pour les autres marques de cartes, les règles du système déterminent l'effet sur la période de validité.
- L'opération UPDATE AUTHORIZATION (Mettre à jour l'autorisation) n'est pas entièrement prise en charge par les acquéreurs S2I, quelle que soit la marque de la carte. Ils peuvent uniquement diminuer le montant de l'autorisation à l'aide de cette opération.
| URL | https://anzegate.gateway.mastercard.com/api/rest/version/72/merchant/<merchant_ID>/order/<order_ID>/transaction/<transaction_ID> |
| Méthode HTTP | PUT |
{
"apiOperation": "UPDATE_AUTHORIZATION"
}
Gestion des totaux de commandes
Après une demande UPDATE AUTHORIZATION (Mettre à jour l'autorisation) réussie (pour une carte ou pour PayPal), le montant de la commande (order.amount) et le montant total autorisé (order.totalAuthorizedAmount) sont mis à jour avec le montant de la transaction (transaction.amount) de la transaction UPDATE AUTHORIZATION (Mettre à jour l'autorisation). Ces mises à jour s'appliquent que la transaction UPDATE AUTHORIZATION (Mettre à jour l'autorisation) ait été soumise à l'acquéreur ou automatiquement approuvée par la passerelle (response.gatewayCode = APPROVED_AUTO).
Si vous choisissez de contourner la mise à jour d'autorisation pour une demande Excessive Capture (Collecte excessive) (en soumettant transaction.authorizationAdjustmentActions = NO_ACTION, voir Utiliser les collectes excessives) et que la passerelle de paiement soumet une demande Excessive Capture (Collecte excessive) à l'acquéreur de paiement, les totaux des commandes ne sont pas mis à jour.
Gestion des sous-totaux de commande
Vous pouvez indiquer les montants de sous-total suivants dans la demande UPDATE AUTHORIZATION (Mettre à jour l'autorisation) pour les paiements par carte ou PayPal :
- order.itemAmount
- order.shippingAndHandlingAmount
- order.taxAmount
- order.discount.amount (paiements par carte uniquement)
- order.gratuityAmount (paiements par carte uniquement)
L'indication order.cashbackAmount dans la demande UPDATE AUTHORIZATION (Mettre à jour l'autorisation) n'est pas prise en charge.
La passerelle ne valide pas si la somme des montants des sous-totaux est égale à transaction.amount (order.amount).
Surcoût
Vous pouvez mettre à jour un montant de surcoût dans la demande UPDATE AUTHORIZATION (Mettre à jour l'autorisation) en utilisant l'un des champs suivants :
- order.merchantCharge.amount : utilisez ce champ si vous fournissez un montant de surcoût précalculé.
- order.merchantCharge.type : définissez ce champ sur SURCHARGE pour indiquer que le type de frais est un surcoût.
- order.netAmount : utilisez ce champ si la passerelle calcule le montant de surcoût (en fonction de vos règles de surcoût). Le montant net est le montant à payer pour la commande avant l'application du surcoût.
Verify (Vérifier)
La transaction VERIFY (Vérifier) permet de vérifier les détails du compte du payeur avant d'effectuer une transaction PAY (Payer) ou AUTHORIZE (Autoriser). Elle vérifie les détails du paiement selon la méthode de vérification prise en charge par l'acquéreur. Par exemple, si la passerelle détermine que l'acquéreur prend en charge le Service de vérification d'adresse (AVS), la passerelle envoie à l'acquéreur une transaction AVS uniquement avec le montant de la transaction à zéro et les détails de l'adresse du payeur pour obtenir le résultat de la vérification.
| URL | https://anzegate.gateway.mastercard.com/api/rest/version/72/merchant/<merchant_ID>/order/<order_ID>/transaction/<transaction_ID> |
| Méthode HTTP | PUT |
{
"apiOperation": "VERIFY",
"order": {
"currency": "EUR"
},
"sourceOfFunds": {
"token": "<token>"
}
}
Void (Annuler)
La transaction VOID (Annuler) tente de supprimer ou d'annuler immédiatement une demande de transaction précédente.
Vous pouvez annuler les transactions AUTHORIZE (Autoriser), CAPTURE (Collecter), PAY (Payer), REFUND (Rembourser), STANDALONE CAPTURE (Collecte autonome), STANDALONE REFUND (Remboursement autonome) et UPDATE AUTHORIZATION (Mettre à jour l'autorisation).
Pour une transaction AUTHORIZE (Autoriser), une transaction VOID (Annuler) libère immédiatement tous les fonds réservés. Pour tous les autres types de transactions, une transaction VOID (Annuler) empêche le transfert de fonds.
Pour annuler les autres transactions, elles ne sont pas envoyées à l'acquéreur pour traitement en fin de journée. Une fois que l'acquéreur envoie une transaction pour traitement, l'opération d'API VOID (Annuler) échouera, vous devrez à la place utiliser une transaction REFUND (Rembourser).
| URL | https://anzegate.gateway.mastercard.com/api/rest/version/72/merchant/<merchant_ID>/order/<order_ID>/transaction/<transaction_ID> |
| Méthode HTTP | PUT |
{
"apiOperation": "VOID",
"transaction": {
"targetTransactionId": "<ID_of_transaction_to_be_voided>"
}
}