Open Payment Framework

Objective

After completing this lesson, you will be able to identify updates to the Open Payment Framework

Introduction to the Open Payment Framework

The SAP Commerce Cloud, open payment framework enables you to integrate your preferred digital payment service providers intuitively and effectively. There is no need to code, integrate and deploy extensions to the Commerce codebase.

Note

The open payment framework is fully compatible with SAP Commerce Cloud release 2211.35 and all subsequent releases. Our phased rollout plan will prioritize customers who have registered their interest through our Early Adopter Care Program for the open payment framework service.

An Overview of Open Payment Framework

Freedom of Choice: With the open payment framework, you are not limited to using only preset payment integration templates. You can bring your own payment gateways and payment methods.
Broad Coverage: The open payment framework features support for diverse integration patterns, capture methods, and payment workflows. It accommodates cards, alternative payment methods (APM), and numerous other options.
Low Code Interface: Using a low-code approach, the open payment framework enables you to personalize standard integrations with ease. This approach enables payment configuration accessibility to a broader technical community, not just developers.
The open payment framework's workbench configuration tool simplifies and reduces errors in referencing smart fields while scripting with FreeMarker and JavaScript. It does so by offering intuitive IDE-style auto-completion and lookup features.

For details and key features, see: Introduction to Open Payment Framework

Setting Up the Open Payment Framework in SAP Commerce Cloud

Here is a comprehensive playlist of step-by-step videos designed to guide you through the entire journey of integrating payment services using the SAP Commerce Cloud Open Payment Framework (OPF): Setting up Open Payment Framework in SAP Commerce Cloud - Video Series Walkthrough

B2B Checkout

Integrate account-based payments into your current payment system, enabling the utilization of the open payment framework's B2B checkout feature. By doing so, you can achieve more streamlined and efficient business transactions.

To gain deeper insights, see Open Payment Framework B2B Checkout.

Why?

As a merchant, you can now leverage the open payment framework to offer a manual payment solution. Currently, this solution supports account-based payments as the primary B2B transaction method, allowing your customers to settle orders offline. While we plan to expand our manual payment options shortly, account-based payments remain a strategic choice—particularly for high-value orders or businesses that prefer to decouple payment processing from order placement.

A New Smart Field: Capture Method

The open payment framework (OPF) now supports dynamic configuration of payment capture methods via a new "Capture Method" smart field, enhancing flexibility and consistency across transaction workflows.

We are pleased to introduce the "Capture Method" smart field, designed to unify and simplify the management of payment capture processes across transaction types. This field dynamically determines how payment capture should be handled based on the transaction context:

For Initial Authorization Transactions: The capture method value is sourced from the payment configuration settings, specifying how the payment should be captured (e.g., immediate, delayed) as defined during integration setup.
For Subsequent Transactions (Reauthorization, Settlement, Refund, Reversal, and Related Outbound Requests): The value is retrieved from the payment context saved or updated during the initial authorization stage, ensuring consistency in capture behavior throughout the payment lifecycle.

The smart field is automatically available for the following transaction types and their respective outbound requests: Authorization, Apple Pay, Google Pay, Reauthorization, Settlement, Refund, and Reversal. By centralizing capture method logic, this feature streamlines configuration, reduces manual adjustments, and ensures seamless alignment with gateway requirements.

For more insights on smart fields usage in the Open Payment Framework, including best practices and advanced configurations, see Smart Fields and Scope.

Why?

This enhancement eliminates manual configuration overhead and ensures consistent application of settlement patterns across gateways, enabling users to dynamically adapt capture methods based on transaction context while reducing integration complexity and accelerating time-to-market for payment workflows.

Enhanced Smart Field API with Dynamic Field Descriptions

Previously, the smart field documentation often contained outdated or incomplete descriptions, which led to confusion during transaction mapping. To address this issue, the open payment framework (OPF) has implemented a significant enhancement to the smart field API.

To access these real-time descriptions, you can use the updated GET endpoint:

GET /merchant/accountgroups/{groupId}/accounts/{accountId}/{requestType}/smartfields/{templateType}

This endpoint provides you with the latest and most accurate information about smart fields, empowering you to streamline field mapping with clarity. By using this endpoint, you can reduce configuration errors and ensure compliance through self-documenting API interactions.

For further information on Smart Fields and their scope, see Smart Fields and Scope documentation.

Why?

The OPF now integrates dynamic, up-to-date field descriptions directly into the smart field API responses. These descriptions cover various aspects of smart fields, including payment configurations, runtime properties, and custom variables. This integration ensures that the API serves as the single source of truth for all smartfield-related information.

Support for Flexible Deployment of OCC API and Integration API with SAP Commerce Cloud

The open payment framework (OPF) now offers flexible SAP Commerce Cloud integration, allowing deployment of the OCC API and Integration API on shared or separate aspects.

If no OCC API URL is given, OPF will use the Integration API URL for backward compatibility. Overall, this update gives you more control and flexibility in managing your SAP Commerce Cloud environment.

For additional details on this improvement, refer to the example provided in Creating SAP Commerce Cloud Client.

Why?

With the latest update to the open payment framework (OPF) in SAP Commerce Cloud, you now have greater flexibility in deploying the OCC API (for storefront request validation) and Integration API (for backend payment operations). You can choose to deploy these APIs on the same or separate aspects based on your specific needs and preferences. This enhancement allows you to optimize your system architecture for performance, scalability, and security.

Enhanced Security and Integration with Redirect Parameters

A new feature has been introduced to manage an allowlist or blocklist of redirect parameters within the Parameter Filter Mode. This enables secure data relay for iFrame and Payment Page payment forms by ensuring that only approved parameters are used in redirects.

For more information about this feature, see Configuring Redirect Parameter Settings.

Why?

Implementing this feature delivers substantial business value by bolstering security, safeguarding data integrity, and preserving operational efficiency. By restricting redirects to approved parameters, it mitigates risks of security breaches and data leaks, ensuring sensitive information remains protected. Strict control over parameters also prevents tampering during transactions, maintaining the accuracy and trustworthiness of payment data. Crucially, the feature integrates seamlessly with existing configurations, avoiding disruptions and enabling teams to sustain smooth operations while prioritizing enhancements to customer experience.

New Two-Environment Setup Options for Your Payment Integrations

You can now configure your payment integration environments with two-environment setups—whether you operate with Development + Production or Staging + Production. This update gives you the flexibility to align your workflows with your project needs, resources, and timelines while maintaining security and validation rigor.

To gain more information of this enhancement, see Going Live: From Test to Production.

Why?

Adapt Your Workflows: Choose between two simplified setups without compromising on deployment stability.
Maintain Validation Standards: Ensure payment integrations are rigorously tested (in Staging or Development) before going live in Production.

JavaScript SDK for Custom Storefronts

A JavaScript SDK has been provided to render payment forms and manage payment sessions in custom storefronts.

The SDK also supports redirect handling after payment submission through the /storefront/{baseSiteId}/payments/{paymentSessionId}/after-redirect-scripts endpoint.

For comprehensive implementation details, see Getting Started with JavaScript SDK for Custom Storefronts.

Why?

This JavaScript SDK simplifies payment integration for custom storefronts by standardizing interactions with SAP Commerce Cloud, open payment framework. It provides a structured approach that handles payment session initialization, callback management, and secure communication with the open payment framework.

Resend Payment Notification Button

With the "Resend Notification" button, you can now easily resend payment transaction notifications to SAP Commerce Cloud whenever needed, ensuring you stay informed and in control.

Key Benefits

Universal Access: The "Resend Notification" button is available for all payment transaction types, except for recurrent authorizations. This means you have the flexibility to resend notifications for most of your transactions with just a click.
Special Handling for Recurrent Authorizations: or your security and convenience, the button is disabled for recurrent authorizations. This prevents unintended resends for these specific types of transactions, reducing the risk of confusion or errors.
Enhanced Clarity for Settlements: When resending notifications for settlement transactions (specifically, the Capture transactions in the open payment framework), a dialog box will appear. It informs you that if the capture has any related recurrent authorizations, these will be resent together with the capture notification. This ensures all related payment activities are synchronized, keeping your records accurate and up-to-date.

Enhanced Admin Role

The Admin role has been enhanced for payment transactions.

The Admin role now includes both read and write access for payment transactions. While it is possible to assign a user both the Developer and Admin roles, it is not recommended to assign both to a single user.

Key Benefits

Stronger Security: While a single user can have both Admin and Developer roles, it’s best to keep them separate. This avoids accidental changes, ensures accountability, and keeps your payment system secure.
Better Control Over Payments: Since administrators have both read and write access to payment transactions, they can easily view, manage, and update payment details without support from developers.
Simpler and Safer Operations: Separating roles makes it easier to track who did what, reduces confusion, and helps your team stay compliant with security best practices. This keeps your payment processes smooth and reliable.

Next lesson