Welcome to YallaPay's Payment Gateway!
This documentation contains all the necessary information needed to integrate with our payment gateway and start accepting payments. Please begin by creating a dashboard account with us YallaPay. When creating your account you will be given the option of enabling two factor authentication - we highly recommend downloading any of the various two factor authentication applications and enabling 2FA for the highest level of security.
GETTING TO KNOW YOUR DASHBOARD
The dashboard is where you will oversee and manage your account. Within the dashboard you will find five main tabs - Home, Transactions, Developers, Payment Links and Settings. There are also critical features of the portal like the test/live mode toggle and business selector that will be discussed.
Home
The home tab is the first screen you will be greeted with when you login. There you'll have the ability to view statistics about your latest transactions, account balance and more. A date selector gives you the ability to see statistics about a chosen date range.
Test and Live Mode
Learn how to use Test Mode for integration and development before switching to Live Mode. Business verification is required to transition from test to production environment.
Business Selector
Learn how to create and switch between multiple business accounts within your YallaPay dashboard. Each account can have up to 5 separate businesses with independent configurations.
Transactions
View, search, filter, and download your transaction history. Track successful and failed payments, search by reference numbers, and export data as CSV for auditing and reconciliation.
Developers
Access API credentials, manage IP whitelist settings, and configure webhooks in the Developers tab. This section provides essential tools for integrating YallaPay's payment gateway into your system.
Settings
Configure your account profile, security settings, and compliance requirements. Upload business documents for verification and customize your checkout page with your business logo.
INTEGRATION
Integrating with our payment gateway is simple and straightforward! We have three main types of integrations to begin accepting payments - Web Checkouts, Mobile SDKs and Direct APIs.
System Overview
Understand YallaPay's payment system architecture and how different components interact. Learn about our payment flow, security measures, and integration options.
Web Checkout
Implement our hosted checkout solution for websites and mobile apps. Learn how to generate payment links, handle redirects, and process transactions using our web checkout API.
Direct API
Implement direct API integration for OTP payment methods. Learn the three-step process of obtaining payment intent, requesting OTP, and confirming payment with complete code examples.
Mobile SDK
Integrate YallaPay payment solutions into your mobile applications. Currently under development, with alternative integration options available through Web Checkout and Direct API.
Redirects and Webhooks
Learn how to configure redirects and webhooks for seamless payment integration. Set up success/failure redirect URLs and secure webhook notifications for real-time payment status updates.
Checking Payment Status
Learn how to check the status of a payment after it has been initiated using Web Checkout or Direct API.