xp-uam-it-api

1.0.x
(0 reviews)

Edenred's Universal Acceptance Method (UAM) API

Introduction

Welcome to the future of payment processing with Edenred's Universal Acceptance Method (UAM) API. This innovative API is designed to handle all types of payments accepted by Edenred, providing a seamless and enhanced user experience for both beneficiaries and merchants.

Purpose

The UAM API aims to revolutionize the way payments are made and accepted. By integrating complementary payments and improving the overall user experience, we're not just facilitating transactions; we're transforming them.

Why UAM API?

  • All-in-One Solution: Accept all Edenred payment products, from traditional meal vouchers to modern NFC token-based transactions.
  • Complementary Payments: Seamlessly integrate the remaining balance with bank cards, all within the same payment event.
  • User Experience: A streamlined process for beneficiaries and merchants, making payments quick, easy, and secure.
  • Technical Excellence: With robust authentication protocols and backward compatibility, the UAM API is both secure and future-proof.

For Whom?

Whether you're a small merchant with an Edenred POS or app (SoftPOS), or a large retail chain integrated with Edenred systems, the UAM API is designed to cater to your needs, ensuring universal applicability across all acceptance networks.

How It Works

  • Payment Initiation: Initiate payments using an NFC token, loaded on either a smartphone or a contactless card or using barcode , otp and chip.
  • Payment Orchestration: Let Edenred's systems handle the payment details, from selecting the type and amount of vouchers to calculating the remaining balance.
  • Complementary Payment: Cover any remaining balance with a bank card, all orchestrated within the same payment event for a frictionless experience.

Integration and Usage

Integrating the UAM API is straightforward, with clear documentation and wrappers available. Authentication is tailored to the type of merchant, ensuring secure and reliable communication with Edenred's backend systems.

API Structure

The UAM API allowing for payment requests, status checks, and reversals. It's designed with backward compatibility in mind, ensuring a smooth transition from existing payment systems.

Backward Compatibility

As mentioned, the UAM API is designed to support, in addition to the UAM payment itself, also the as-is payments.

The service is therefore structured to convey:

  • The UAM payment complete with any complementary payment;
  • The as-is OTP payment;
  • The as-is barcode dematerialization;
  • The physical card payment (TBD requires adjustments compared to current logic).

The type of payment conveyed is indicated by the "flow" attribute, according to one of the admitted values: "uam"; "otp"; "card"; "barcode".

In the following chapters of the document, the specific use cases are detailed.

Conventions

  • Amounts: Expressed in cents, without commas or thousand separators.
  • Currency: The reference currency is EUR, explicitly indicated in the "currency" attribute.

Conclusion

The UAM API by Edenred Italia Srl is not just a payment processing tool; it's a gateway to a more connected, efficient, and user-friendly transaction ecosystem. Embrace the ease of use and technical sophistication of the UAM API, and elevate your payment experience today.

For more information and to start integrating the UAM API, visit our documentation portal.

Reviews