- 集成指南
- 支持的功能（付款方式）
- American Express 会员奖励
American Express 会员奖励
Mastercard Gateway 允许您向付款人提供 American Express Membership Rewards 作为付款方式。
American Express Membership Rewards 是一项客户忠诚度计划，奖励使用 American Express 借记卡/信用卡的付款人。 注册此计划的付款人使用此卡购物可赚取积分，随后可在使用此卡购物并满足条件时，将可用积分兑换为等值货币。 有关此奖励计划的更多详细信息，请参见 American Express 网站。
对以下交易支持通过网关提供 American Express Membership Rewards：
- 互联网交易 (
transaction.source=INTERNET) - 一次性付款
- Authorize 交易 (
apiOperation=AUTHORIZE)
先决条件
要通过网关提供 American Express Membership Rewards：
- 您必须注册 American Express Membership Rewards 计划。
- 您在网关上的商家配置文件必须由 your payment service provider 进行 American Express Membership Rewards 收单行相关配置。
在您的集成中添加对 American Express Membership Rewards 的支持
如果您希望在自己的付款页上提供 American Express Membership Rewards 作为付款方式，您可以使用 Direct Payment 进行集成。
您需要实施的集成步骤取决于您想要在购物网站上支持的付款场景：
当付款人选择使用 American Express Membership Rewards 付款时，您必须首先检查是否有奖励余额。 您应该仅在付款人有可用奖励余额时提供 American Express Membership Rewards。 如果付款人在您的购物网站上设置了账户，在付款人查询余额时，您也可以检查奖励余额。
您可以使用 DirectAPIBalance Inquiry 操作请求卡上的奖励余额。 向付款人提供余额信息以便他们能够兑换有效的奖励（积分）数，这一点很重要。 余额信息提供最高和最低支出金额，以及增量支出金额。 例如，如果最低消费金额为 100 美元，最高消费金额为 500 美元，增量消费金额为 20 美元，则付款人可以在购物时以 20 美元为增量，兑换价值 100 美元到 500 美元的积分。 如果购买金额为 155 美元，他们可以使用奖励积分兑换 140 美元，同时需要使用卡支付其余 15 美元。
您需要在 Balance Inquiry 请求中提供以下字段：
sourceOfFunds.type=CARDsourceOfFunds.provided.card.number: 与您请求奖励余额信息的 American Express Membership Rewards 关联的借记卡/信用卡号码。sourceOfFunds.provided.card.expirysourceOfFunds.provided.card.securityCode
Balance Inquiry API 参考[REST][NVP]
Balance Inquiry 请求的响应字段将确定您的下一步操作，如下表所示。
Balance Inquiry 响应字段 |
具体含义... |
|---|---|
result=SUCCESSbalanceId: 这是在卡上有奖励余额时网关生成的唯一标识符。 availableBalance.reward.amountavailableBalance.reward.currencyavailableBalance.reward.pointsavailableBalance.reward.program=AMERICAN_EXPRESS_MEMBERSHIP_REWARDSavailableBalance.reward.conversionRateavailableBalance.reward.incrementalSpendAmountavailableBalance.reward.maximumSpendAmountavailableBalance.reward.minimumSpendAmountresponse.gatewayCode=BALANCE_AVAILABLE
|
提供卡的余额信息。 请注意可用余额可能为零。 如果付款人希望兑换奖励积分，您可以向付款人提供此信息，然后为此卡提交授权。 |
result=SUCCESSresponse.gatewayCode=NO_BALANCE |
卡的余额信息不可用，例如，卡未注册奖励计划。 付款人将无法使用奖励积分进行付款。 |
result=FAILUREresponse.gatewayCode=TIMED_OUT |
余额查询请求不成功，例如，向收单行发出的请求超时、系统错误。 您可以稍后再试。 |
如果有奖励余额，您可以建议付款人兑换奖励积分来付款。 如果付款人希望消费奖励，请提交包含奖励金额的卡授权。 奖励金额可以覆盖部分或全部订单金额（但不得超过订单金额）。 作为先决条件，在提交授权之前必须通过网关成功执行卡的余额查询（您需要在授权交易中提供余额查询请求返回的余额 ID）。
您需要在 Authorize 请求中提供以下字段：
order.reward.balanceId: 在BALANCE_INQUIRY响应中返回给您的balanceId字段的值。order.reward.amount: 付款人选择通过兑换奖励积分支付的金额。
如果成功，除了标准字段之外，还会返回以下响应字段：
order.reward.amount，与您的请求中的字段相同。order.reward.points: 付款人兑换此订单的全部或部分付款的奖励价值（积分）。order.reward.program=AMERICAN_EXPRESS_MEMBERSHIP_REWARDS
如果响应中没有返回这些字段，则表示奖励授权不成功，即付款人无法兑换奖励积分。 在这种情况下，您必须向付款人提供继续订单而不兑换奖励金额的选项。
过账和退款
您可以对与卡交易类似的包含奖励金额的订单执行过账和退款。 如果交易成功，将会结算到卡账户中。 奖励金额不支持独立过账和退款。
品牌要求
当您在付款页上显示 American Express Membership Rewards 作为付款选项时，您必须遵守 American Express 的品牌要求。 您还必须在结账页面上提供 American Express Membership Rewards 条款和条件的链接。 有关品牌要求的更多信息，请联系 American Express。
测试并上线
您可以使用您的测试商家配置文件测试 American Express Membership Rewards 卡集成。