Welcome to the UPayments Gateway API, This API, powered by UInterfaceV2, lets you easily add secure payment processing to your e-commerce store, web, or mobile application.
What is UInterfaceV2?
UInterfaceV2 is the new, enhanced payment gateway API. It enables you to seamlessly integrate payment gateways into your website or mobile app.
UPayments is a licensed financial service provider regulated by the Central Bank of Kuwait, ensuring your transactions are always safe and reliable.
Accepted Payment Methods
We support a wide range of digital payment methods, including:
- KNET (Debit Cards)
- Credit Cards (Visa, Mastercard, etc.)
- Apple Pay
- Google Pay
- Samsung Pay
How Payment Transactions Work
Understanding the payment flow helps you integrate smoothly. Here's a quick overview:
-
Initiation
- Starts when the customer initiates a payment request.
- Your customer chooses a payment method.
- You use the Add Charge endpoint to begin the transaction.
-
Payment Processing
- Encryption and Transmission
- Payment information is securely transmitted to a payment gateway.
- Data is encrypted and forwarded to the payment processor.
- Authorization
- Payment processor sends transaction details to the acquiring bank.
- Acquiring bank forwards information to the issuing bank through the card network.
- Issuing bank verifies the account, checks for sufficient funds or credit.
- Issuing bank sends approval/decline via the card networks and acquiring bank to the payment processor
- Encryption and Transmission
-
Transaction Response
After a customer completes or attempts a payment, you'll get the transaction's outcome:- Successful payments will redirect your customer to the
returnUrl
you provide. - All other scenarios (failed, canceled, or pending payments) will redirect to your
cancelUrl
.
For real-time, server-to-server updates on transaction status, set up a Webhook. This is the most reliable way to confirm payment results.
- Successful payments will redirect your customer to the
-
Check your payment status
If you don't receive an immediate response, use the Check Payment Status endpoint to get the latest update for any previous transaction. This ensures you always have the correct status.
Beyond Payments
Refunds & Settlements
- Refund endpoint: Easily process refunds.
- Settlements: Funds are deposited into your merchant bank account by the next business day.
Saving Cards (Tokenization)
- Create Customer unique token endpoint: Securely tokenize customer card details.
- Add Card endpoint: Link multiple cards to a customer token.
- Retrieve Customer Cards endpoint: Access saved card details via the token.
More API Features
- Multivendor API: For platforms with multiple vendors.
- Create invoices or payment links: Generate direct payment links for your customers.
Get the Test API details
To try out the test API, navigate to Test Environment Checklist
Get the Production API details
For Production API (Bearer) Token, contact [email protected] or +965 1809888
If you already have UInterface API access, you can find your API details (Key or Token) directly from your UPayments Merchant Dashboard:
- Login to your UPayments Account
- Go to the Payment Gateway Page.
- Access the Payment Gateway Details Page.