Payment

Exirom's Alternative Payment Methods (APM) API allows you to initiate transactions using a variety of payment methods beyond traditional credit and debit cards. These include options such as e-wallets, mobile wallets, bank transfers, direct debits, Buy Now Pay Later services, and other local payment methods. By using this API, you can process payments through popular alternatives like PayPal, iDEAL, Google Pay, Apple Pay, or Exirom’s own ExPay e-wallet, among others, and receive real-time notifications (callbacks) with transaction results.

This guide outlines the end-to-end flow of an APM payment, from initiating the payment request to handling user redirection (if required), receiving the payment status callback, and optionally querying the payment status. It also details the request and response formats, headers, and important considerations for integration.

Pages in this Section

This section provides a walkthrough of alternative payment methods. Let’s dive into each topic in detail by navigating to its respective subpages:

✅ Payment Flow - An overview of the complete payment lifecycle, showing how requests move through the Exirom system, from merchant initiation to provider response and final settlement.

✅ Initiating a Payment - Instructions for creating and sending a new payment request using the APM API. Includes required request fields, sample payloads, and tips for successful submission.

✅ Processing the Payment Response - Explains how to handle the immediate API response after initiating a payment, including reading apmResponseData and directing the customer to complete the payment.

✅ Handling the Callback - Details how to process asynchronous webhook notifications that confirm the final status of a transaction. Covers security checks, idempotency, and recommended handling logic.

✅ Retrieving Payment Status - Describes how to fetch the latest status of a transaction using its unique ID. Useful for cases where the callback is delayed or missed.

✅ Error Handling - Covers common API errors, their causes, and recommended recovery actions. Includes HTTP status code references and troubleshooting guidelines.

✅ apmPayload References - Provides detailed reference tables for all supported apmPayload types, including required fields for each payment method.

✅ Smart APM Routing Engine - Explains how the Smart APM routing logic selects the optimal payment method based on transaction context, merchant preferences, and customer location.

✅ External Apple Pay Payload - Describes how to integrate Apple Pay via an external Hosted Checkout Page (HPP), including payload requirements and example responses.