- Directives d'intégration
- Fonctionnalités prises en charge (Modes de paiement)
- American Express Membership Rewards
American Express Membership Rewards
Mastercard Gateway vous permet de proposer American Express Membership Rewards comme mode de paiement à vos payeurs.
American Express Membership Rewards est un programme de fidélisation des clients qui récompense les payeurs pour l'utilisation de leurs cartes de débit/crédit American Express. Les payeurs inscrits au programme gagnent des points sur les achats effectués avec la carte et peuvent ensuite échanger les points disponibles contre un équivalent en devise lors d'un achat éligible avec la carte. Pour plus d'informations sur le programme de récompenses, voir le site Web d'American Express.
La prise en charge d'American Express Membership Rewards via la passerelle est fournie pour :
- Les transactions sur Internet (
transaction.source=INTERNET) - Les paiements uniques
- Autoriser les transactions (
apiOperation=AUTHORIZE)
Conditions préalables
Pour proposer American Express Membership Rewards via la passerelle :
- Vous devez vous inscrire au programme American Express Membership Rewards.
- Votre profil de commerçant sur la passerelle doit être configuré pour l'acquéreur American Express Membership Rewards par votre your payment service provider.
Ajout de la prise en charge d'American Express Membership Rewards à votre intégration
Si vous souhaitez proposer American Express Membership Rewards comme mode de paiement sur votre propre page de paiement, vous pouvez l'intégrer en utilisant Direct Payment.
Les étapes d'intégration que vous devez mettre en œuvre dépendent des scénarios de paiement que vous souhaitez prendre en charge sur le site de votre boutique :
- Si vous souhaitez présenter le solde des récompenses disponibles sur une carte, vous ne devez suivre que de l'étape 1.
- Si vous souhaitez proposer au payeur la possibilité d'échanger des points de récompense contre un paiement, les étapes 1 et 2 sont requises.
Lorsqu'un payeur choisit de payer en utilisant American Express Membership Rewards, vous devez d'abord vérifier si un solde des récompenses est disponible. Vous ne devez proposer des récompenses que si un solde des récompenses est disponible pour le payeur. Vous pouvez également vérifier le solde des récompenses en cas de demande de solde émanant d'un payeur dont le compte est ouvert sur le site de votre boutique.
Vous pouvez demander le solde des récompenses sur la carte à l'aide de l'opération APIBalance Inquiry (Demande de solde). Il est important de présenter les informations de solde au payeur afin de lui permettre d'échanger un nombre valide de récompenses (points) pour ses achats. Les informations sur le solde indiquent les montants de dépenses maximum et minimum, ainsi que le montant de dépense par incrément. Par exemple, si le montant de dépense minimum est de 100 $, le montant de dépense maximum est de 500 $ et le montant de dépense par incrément est de 20 $, le payeur peut échanger des points pour des achats d'un montant compris entre 100 $ et 500 $ par incréments de 20 $. Si l'achat concerne 155 $, il peut échanger 140 $ contre des points de récompense et devra payer le solde de 15 $ sur sa carte.
Vous devez renseigner les champs suivants dans la demande Balance Inquiry (Autoriser) :
sourceOfFunds.type=CARDsourceOfFunds.provided.card.number: numéro de carte de débit/crédit associé au programme American Express Membership Rewards pour lequel vous demandez des informations sur le solde des récompenses.sourceOfFunds.provided.card.expirysourceOfFunds.provided.card.securityCode
Référence de l'API Balance Inquiry (Demande de solde)[REST][NVP]
Les champs de réponse d'une demande Balance Inquiry (Demande de solde) déterminent l'étape suivante, comme indiqué dans le tableau ci-dessous.
Champs de réponse Balance Inquiry (Demande de solde) |
Qu'est-ce que cela signifie ? |
|---|---|
result=SUCCESSbalanceId: identifiant unique généré par la passerelle lorsqu'un solde de récompenses est disponible pour la carte. availableBalance.reward.amountavailableBalance.reward.currencyavailableBalance.reward.pointsavailableBalance.reward.program=AMERICAN_EXPRESS_MEMBERSHIP_REWARDSavailableBalance.reward.conversionRateavailableBalance.reward.incrementalSpendAmountavailableBalance.reward.maximumSpendAmountavailableBalance.reward.minimumSpendAmountresponse.gatewayCode=BALANCE_AVAILABLE
|
Les informations sur le solde de la carte sont disponibles. Notez que le solde disponible peut être nul. Vous pouvez présenter ces informations à votre payeur et soumettre ensuite une autorisation pour cette carte si le payeur souhaite échanger les points de récompense. |
result=SUCCESSresponse.gatewayCode=NO_BALANCE |
Les informations sur le solde de la carte ne sont pas disponibles, par exemple, carte non inscrite au programme de récompenses. Le payeur ne pourra pas utiliser de points de récompense pour le paiement. |
result=FAILUREresponse.gatewayCode=TIMED_OUT |
La demande Balance Inquiry (Demande de solde) a échoué, par exemple car la demande a expiré dans le temps imparti à l'acquéreur ou en raison d'une erreur système. Vous pourrez réessayer après un certain temps. |
Si un solde de récompenses est disponible, vous pouvez proposer au payeur d'échanger des points de récompense contre son paiement. Si le payeur souhaite dépenser des récompenses, soumettez une autorisation pour la carte avec le montant des récompenses. Le montant des récompenses peut couvrir tout ou partie du montant de la commande (mais ne doit pas dépasser le montant de la commande). La condition préalable est qu'une demande Balance Inquiry (Demande de solde) pour la carte ait été effectuée avec succès via la passerelle avant de soumettre l'autorisation (vous devrez fournir l'ID de solde renvoyé pour la demande Balance Inquiry (Demande de solde) dans la transaction d'autorisation).
Vous devez renseigner les champs suivants dans la demande Authorize (Autoriser) :
order.reward.balanceId: La valeur du champbalanceIdqui vous a été renvoyée dans la réponseBALANCE_INQUIRY(Demande de solde).order.reward.amount: Le montant que le payeur a choisi de payer en utilisant des points de récompense.
En cas de succès, les champs de réponse suivants sont renvoyés en plus des champs standard :
order.reward.amount, en écho à votre demande.order.reward.points: la valeur des récompenses (points) que le payeur a utilisées en paiement total ou partiel pour cette commande.order.reward.program=AMERICAN_EXPRESS_MEMBERSHIP_REWARDS
Si ces champs ne sont pas renvoyés dans la réponse, cela signifie que l'autorisation de récompense n'a pas abouti, c'est-à-dire que le payeur ne peut pas échanger les points de récompense. Dans ce cas, vous devez présenter au payeur la possibilité de procéder à la commande sans utiliser le montant des récompenses.
Collectes et remboursements
Vous pouvez effectuer des collectes et des remboursements sur une commande contenant un montant de récompenses de la même manière qu'une transaction par carte. Les transactions, en cas de succès, seront réglées sur le compte de la carte. Les collectes et les remboursements autonomes ne sont pas pris en charge avec le montant des récompenses.
Conditions requises pour la stratégie de marque
Lorsque vous affichez American Express Membership Rewards comme option de paiement sur votre page de paiement, vous devez vous conformer aux exigences de marque d'American Express. Vous devez également fournir un lien vers les conditions générales du programme Membership Rewards d'American Express sur la page de paiement. Pour plus d'informations sur les exigences en matière d'image de marque, contactez American Express.
Test et mise en service
Vous pouvez tester l'intégration de votre carte American Express Membership Rewards à l'aide de votre profil de commerçant de test.