Skip to main content

Introduction

Payen provides an Alternative Payment Method (APM) integration in which the customer is redirected to a third-party payment provider to complete the payment, while still benefiting from the Payen transaction lifecycle, processing logic, and risk controls.

This integration uses a full-page redirect to the selected APM provider, where the customer completes the payment. Unlike our embedded solution where we host a payment user interface within the merchant checkout.

The Payen platform continues to manage the transaction lifecycle, notifications, limits, fraud controls, and reporting.

This section describes how to integrate the APM Redirect flow into your checkout.

Overview​

The APM Redirect integration:

  • Does not require embedding the payment user interface.
  • Redirects the customer to the selected third-party payment provider.
  • Maintains the standard Payen transaction lifecycle:
  • Redirect → Notification → Return → Status Retrieval → Completion.
  • Reuses the platform’s existing transaction engine, validation, state management and post-processing workflows.
  • Sends server-to-server notifications to the merchant with the final payment result, allowing the merchant to receive the payment status independently of the customer’s browser.
  • Provides consistent reporting, limits, fraud controls and audit trails.

High-Level Payment Flow​

The APM Redirect lifecycle consists of the following steps:

  1. Initialisation – The merchant creates a transaction by calling https://pripframev2.trustpayglobal.com/ipframe/apm/initialise and receives a requestKey.
  2. APM Processing – The merchant sends the customer’s browser to https://pripframev2.trustpayglobal.com/ipframe/apm/process with the requestKey and selected APM method. The Payen platform validates the request, prepares the transaction, interacts with the APM provider, and processes the payment on behalf of the merchant.
  3. Browser Redirect and Payment Completion – The platform handles the redirect to the APM provider, where the customer completes the payment. Managed by the platform, with no action required from the merchant.
  4. Browser Return to Merchant – After the payment is complete, the platform redirects the customer back to the merchant’s return URL. The merchant receives the customer but should not rely on this return for the final payment status.
  5. Final Transaction Status – The merchant receives the final payment result from the Payen platform. This can happen in one of two ways to ensure the merchant knows the final outcome independently of the customer’s browser:
    • By retrieving the transaction status via the platform’s API, or
    • Automatically via a server-to-server notification sent by the platform.

Key Differences from the Embedded User interface​

Embedded User interfaceAPM Redirect
Hosted secure iframe modalFull-page redirect to APM provider
UI rendered by PayenUI rendered by third-party provider
Customer stays on merchant siteCustomer leaves merchant site
Hosted payment interface embedded in checkoutUnified APM redirect endpoint model

The downstream transaction processing, limits, notification handling, and reporting remain consistent across both models.

info

All the server to server requests are in an JSON or XML format for extensibility.

All API calls are performed over standard HTTPS (SSL) POST. The body and HTTP request must be encoded using UTF-8.

The content type should be set as “application/json” or “text/xml” and the digest should always be sent as an HTTP header. For more information on digest calculation, please see the Digest Calculation section.