Welcome to the integration guide for obtaining your API credentials and setting up essential configurations for seamless payment processing. This document provides a step-by-step process to help you retrieve your Open Client (API credentials), Payment AppId and configure Webhook notifications to ensure smooth and secure communication between your system and our platform.
Create Open Client
Open Client (API Credentials)
Click your name in the upper right corner of the admin panel. Select “API Management” from the dropdown menu.
To add an open client, click the “+Add” button on the right side
Enter your new open client name. Click the “Confirm” button once done.
Copy ClientId and ClientSecret after creation.
Payment App (Store Checkout Configuration)
For detailed setup instructions, please refer to the tutorial at: Create Payment App.
PaymentApp empowers merchants to fully customize their online store experience. Merchants can configure their checkout page by setting their logo, brand name, and selecting payment channels to meet their business needs. Additionally, PaymentApp allows them to define notify_url for notifications, customize the language and style of the checkout page, and choose invoice handling modes.
Create the payment app and get AppId.
Configuring Webhook Notifications
UniPayment allows you to set webhook notification URLs (notify_url) based on the type of transaction. For deposits, payments, and currency exchanges, the notify_url is fixed system-wide.
Configuring Global Notify URL and Secret Key
In this section, you will set the global notify_url, which is responsible for receiving notifications for deposits, payments, and currency exchanges. The secret key is crucial for verifying the authenticity of these notifications and is also used for verifying invoice notifications, ensuring secure communication across all transaction types.
For invoices, you have more flexibility. You can set a notify_url at the payment app level, applying to all invoices from that app, or assign a unique URL to each individual invoice, giving you more control over how notifications are handled.
Method 1: Setting the Payment App Notify URL
Method 1 allows you to set a notify URL at the payment app level. This ensures that all invoices generated by the app will send notifications to the specified endpoint, simplifying the management of webhook notifications for multiple invoices.
Method 2: Setting a Custom Notify URL for Individual Invoices
As an alternative method, you can assign different notify URLs for each invoice. This approach allows greater flexibility in managing notifications for specific transactions, ensuring that each invoice directs notifications to the appropriate endpoint.