- Pautas de integración
- Características soportadas (métodos de pago)
- American Express Membership Rewards
American Express Membership Rewards
El Mastercard Gateway le permite ofrecer American Express Membership Rewards como método de pago a sus pagadores.
American Express Membership Rewards es un programa de fidelización de clientes que recompensa a los pagadores por utilizar sus tarjetas de débito/crédito American Express. Los pagadores inscritos en el programa ganan puntos por compras realizadas con la tarjeta y posteriormente pueden canjear los puntos disponibles por una moneda equivalente al realizar una compra elegible con la tarjeta. Para obtener más detalles sobre el programa de recompensas, consulte el sitio web de American Express.
Se proporciona soporte para American Express Membership Rewards a través del motor de pagos para:
- Transacciones por Internet (
transaction.source=INTERNET) - Pagos únicos
- Autorizar transacciones (
apiOperation=AUTHORIZE)
Prerrequisitos
Para ofrecer American Express Membership Rewards a través del motor de pagos:
- Debe registrarse en el programa American Express Membership Rewards.
- your payment service provider debe configurar su perfil del negocio en el motor de pagos para el adquirente de American Express Membership Rewards.
Agregar soporte para American Express Membership Rewards a su integración
Si desea ofrecer American Express Membership Rewards como método de pago en su propia página de pago, puede realizar la integración mediante Direct Payment.
Los pasos de integración que debe implementar dependen de los escenarios de pago que desea admitir en el sitio de su tienda:
- Si desea presentar el saldo de recompensas disponible en una tarjeta, solo necesita el Paso 1.
- Si desea ofrecer al pagador la opción de canjear puntos de recompensa por un pago, son obligatorios el Paso 1 y el Paso 2.
Cuando un pagador elige pagar con American Express Membership Rewards, primero debe verificar si hay un saldo de recompensas disponible. Solo debe ofrecer American Express Membership Rewards si hay un saldo de recompensas disponible para que el pagador lo gaste. También puede consultar el saldo de recompensas en caso de que un pagador que tenga su cuenta configurada en el sitio de su tienda realice una consulta de saldo.
Puede solicitar el saldo de recompensas de la tarjeta mediante la operación Balance Inquiry de DirectAPI. Es importante presentar la información del saldo al pagador para permitirle canjear una cantidad válida de recompensas (puntos) por sus compras. La información del saldo proporciona los montos de gasto máximo y mínimo, y también el monto de gasto incremental. Por ejemplo, si el monto de gasto mínimo es $100, el monto de gasto máximo es $500 y el monto de gasto incremental es $20, entonces el pagador puede canjear puntos por compras entre $100 y $500 en incrementos de $20. Si la compra es de $155, puede canjear $140 por puntos de recompensa y deberá pagar el saldo de $15 en su tarjeta.
Deberá proporcionar los siguientes campos en la solicitud Balance Inquiry:
sourceOfFunds.type=CARDsourceOfFunds.provided.card.number: El número de tarjeta de débito/crédito asociado con American Express Membership Rewards para el cual solicita información del saldo de recompensas.sourceOfFunds.provided.card.expirysourceOfFunds.provided.card.securityCode
Referencia de API de Balance Inquiry[REST][NVP]
Los campos de respuesta para una solicitud de Balance Inquiry determinarán su siguiente paso, como se muestra en la tabla a continuación.
Campos de respuesta de Balance Inquiry |
¿Qué significa esto? |
|---|---|
result=SUCCESSbalanceId: Este es un identificador único generado por el motor de pagos cuando hay un saldo de recompensas disponible para la tarjeta. availableBalance.reward.amountavailableBalance.reward.currencyavailableBalance.reward.pointsavailableBalance.reward.program=AMERICAN_EXPRESS_MEMBERSHIP_REWARDSavailableBalance.reward.conversionRateavailableBalance.reward.incrementalSpendAmountavailableBalance.reward.maximumSpendAmountavailableBalance.reward.minimumSpendAmountresponse.gatewayCode=BALANCE_AVAILABLE
|
La información del saldo de la tarjeta está disponible. Tenga en cuenta que el saldo disponible puede ser cero. Puede presentar esta información a su pagador y posteriormente enviar una autorización para esta tarjeta si el pagador desea canjear los puntos de recompensa. |
result=SUCCESSresponse.gatewayCode=NO_BALANCE |
La información del saldo de la tarjeta no está disponible; por ejemplo, la tarjeta no está inscrita en el programa de recompensas. El pagador no podrá utilizar puntos de recompensa para el pago. |
result=FAILUREresponse.gatewayCode=TIMED_OUT |
La solicitud de Balance Inquiry no tuvo éxito, por ejemplo, la solicitud al adquirente excedió el tiempo límite, error del sistema. Puede volver a intentarlo después de un tiempo. |
Si hay un saldo de recompensas disponible, puede ofrecer al pagador canjear puntos de recompensa por su pago. Si el pagador desea gastar recompensas, envíe una autorización para la tarjeta con el monto de las recompensas. El monto de las recompensas puede cubrir parte o la totalidad del monto del pedido (pero no debe exceder el monto del pedido). Como prerrequisito, se debe haber realizado una consulta de saldo exitosa para la tarjeta a través del motor de pagos antes de enviar la autorización (deberá proporcionar el ID de saldo devuelto para la solicitud de consulta de saldo en la transacción de autorización).
Deberá proporcionar los siguientes campos en la solicitud Authorize:
order.reward.balanceId: El valor del campobalanceIdque se le devolvió en la respuestaBALANCE_INQUIRY.order.reward.amount: El monto que el pagador ha elegido pagar canjeando puntos de recompensa.
Si tiene éxito, se devuelven los siguientes campos de respuesta además de los campos estándar:
order.reward.amount, reflejado de su solicitud.order.reward.points: El valor de las recompensas (puntos) que el pagador ha canjeado como pago total o parcial para este pedido.order.reward.program=AMERICAN_EXPRESS_MEMBERSHIP_REWARDS
Si estos campos no se devuelven en la respuesta, significa que la autorización de recompensas no fue exitosa, es decir, el pagador no puede canjear los puntos de recompensa. En este caso, deberá presentar al pagador la opción de continuar con el pedido sin canjear el importe de las recompensas.
Capturas y reembolsos
Puede realizar capturas y reembolsos en un pedido que contenga un monto de recompensas de manera similar a una transacción con tarjeta. Las transacciones, si tienen éxito, se liquidarán en la cuenta de la tarjeta. Las capturas y reembolsos independientes no se admiten con el monto de las recompensas.
Requisitos de marca
Al mostrar American Express Membership Rewards como opción de pago en su página de pago, debe cumplir con los requisitos de marca de American Express. También debe proporcionar un vínculo a los términos y condiciones de American Express Membership Rewards en su página de pago. Para obtener más información sobre los requisitos de marca, comuníquese con American Express.
Prueba e inicio de transacciones en producción
Puede probar la integración de su tarjeta American Express Membership Rewards utilizando su perfil de pruebas del negocio.