Interfaces
The Interface (API) defines how your system communicates with the payment gateway. It allows you to configure merchant details, bank accounts, redirect and callback URLs, and supported payment methods (e.g., FPX, DuitNow).
Each merchant may create one or more interfaces depending on their integration and settlement needs.
Creating a New Interface
When creating a new interface, you will be asked to provide the following details:
General Settings
Name – A unique name for your interface (e.g.,
MyShop FPX,Wallet API).Status – Active or Inactive. Only active interfaces can process payments.
Description – Short description of the interface (optional).
Charge Mode – Defines how charges are applied (e.g., Merchant or Customer).
Subaccount - Bank – The subaccount's bank where settlements will be deposited.
URL Settings
These URLs determine how customers and your system handle the payment flow:
Redirect URL – Where customers are redirected after a successful payment.
Cancel URL – Where customers are redirected if they cancel the transaction.
Callback URL – Your system’s endpoint for receiving server-to-server notifications about payment results.
Timeout URL – Used when the transaction session expires before completion.
Gateway Settings
You can enable different payment channels under an interface.
FPX
Gateway – Choose the FPX bank gateway (e.g., Hong Leong Bank UAT).
Bank View – How banks are displayed to customers.
Bank Type – Choose between B2C (Retail customers) or B2B (Corporate customers).
DuitNow
Gateway – Select the DuitNow participating bank.
Bank View – How banks are shown (List).
Bank Type – Typically Retail.
Example Workflow
Create Interface – Define general settings, URLs, and enable required payment gateways.
Use Interface in Forms – Assign an interface for the payment form.
Redirect Customer – After payment, the customer is redirected to the configured URL.
Receive Callback – Your system processes transaction results via the callback URL.
Settlement – Funds are deposited into the chosen subaccount's bank.
Last updated