OvoCheckout is a powerful and flexible online payment gateway solution designed to help businesses securely accept and manage digital payments from customers worldwide. Built for performance, reliability, and scalability, OvoCheckout provides a complete payment processing system that can be fully deployed and managed by the business owner. Whether you are operating an eCommerce store, subscription service, marketplace, or custom web application, OvoCheckout enables seamless transaction handling with full control over configuration, fees, and payment workflows. For hybrid payments, including both fiat and cryptocurrency, the maximum expected processing time is approximately 5–15 minutes, depending on the payment method, network congestion, and confirmation requirements.

The system includes a comprehensive admin panel that allows administrators to manage payment gateways, currencies, transaction records, user accounts, settlements, and system settings from a centralized dashboard. With real-time transaction monitoring and detailed reporting features, OvoCheckout helps businesses maintain transparency and accuracy in financial operations. Merchants can create payment requests, generate invoices, track payment statuses, and monitor revenue growth through an intuitive and easy-to-navigate interface designed for both technical and non-technical users. For faster payment confirmation, businesses can prioritize certain gateways or crypto networks where supported.

Security is a core foundation of OvoCheckout. The platform implements advanced encryption protocols, secure API communication, two-factor authentication (2FA), and fraud prevention mechanisms to ensure that every transaction is processed safely. Supporting multiple payment methods such as credit/debit cards, bank transfers, digital wallets, and cryptocurrencies, OvoCheckout offers flexibility while maintaining high security standards. With complete ownership of the system and full customization capability, businesses can tailor the platform according to their operational needs and branding requirements, while also monitoring maximum transaction durations and confirmations to provide reliable customer experiences.

• PHP Version 8.3 or 8.3+
• MySQL Version 8.0+ or MariaDB version 10.6+
• BCMath PHP Extension
• Ctype PHP Extension
• cURL PHP Extension
• DOM PHP Extension
• Fileinfo PHP Extension
• GD PHP Extension
• JSON PHP Extension
• Mbstring PHP Extension
• OpenSSL PHP Extension
• PCRE PHP Extension
• PDO PHP Extension
• pdo_mysql PHP Extension
• Tokenizer PHP Extension
• XML PHP Extension
• Filter PHP Extension
• Hash PHP Extension
• Session PHP Extension
• Zip PHP Extension
• allow_url_fopen()
• file_get_contents()

Installation Steps:

• Upload the downloaded files directly to your server after purchase to begin setup.
  
• Extract the downloaded file and move all contents from the Files folder to your desired installation directory. Ensure that both index.php and .htaccess are included.
  
  
• Install the PHP dependencies. Open a terminal inside the core folder and run composer install. This generates the core/vendor directory, which is required for the application to run and is intentionally not shipped in the package.
  cd core && composer install --no-dev --optimize-autoloader

  On shared hosting without terminal access, run composer install locally and upload the generated core/vendor folder, or ask your host to run Composer for you. Requires PHP 8.2+ and Composer 2.

• Quickly set up your database using the Database Wizard/Manager in your control panel.
  
• After creating the database, access phpMyAdmin on your server, select the newly created database, and import the project database from the Files/Installation folder.
  
  
  
• After importing the database, update the database credentials in the core/.env file (DB_HOST, DB_DATABASE, DB_USERNAME and DB_PASSWORD) and adjust any other necessary environment variables. Keep APP_DEBUG=false on a live site.
  
  
• Installation is almost complete. Your site is now ready to browse. Simply visit https://your-site-url/admin and log in with the credentials below
  • username:admin
  • password:admin

• After logging in, please change the password for security. Also, remember to remove the installation folder once the project is successfully installed.

• If you're still unable to install the system, please contact us. We offer free installation on cPanel-based hosting.

• assets
  • css - Frontend stylesheets
  • js - Frontend JavaScript files
  • images - Site logo and template graphics
  • templates - Theme-specific template assets
• core
  • app
    • Http
      • Controllers - Handles HTTP request business logic (Admin, API, Payment)
      • Middleware - Route authentication and security filters
    • Models - Eloquent database models
    • Traits - Reusable operation traits (Invoice, User, Wallet operations)
    • Notify - Dispatches Email, SMS, and Push notifications
    • Lib - Custom helper libraries and manager classes
  • config - Framework and custom environment configuration files
  • routes - Grouped application routing definitions
  • resources
    • views - Blade templates for multi-template support
  • storage - Application logs, caching, sessions, and uploads
• install
• .htaccess
• index.php

• assets/: In the assets folder, you'll find all the client-facing assets such as stylesheets (CSS), scripts (JS), fonts, and templates. Any design or styling customizations should be written directly in the related files inside this folder.
• core/: The core folder contains the core Laravel files. It follows the standard MVC architecture pattern for clean organization:
  • - core/app/ holds controllers, middleware, traits, and notification classes.
  • - core/app/Http/Controllers/ contains the logic for processing customer payments, admin configurations, and external API requests.
  • - core/app/Traits/ houses reusable logic traits shared across controllers to manage invoices, deposits, and wallets.
  • - core/config/ holds settings for services, databases, and general variables.
  • - core/routes/ specifies web, API, administrator, and payment webhook routes.
  • - core/resources/views/ contains HTML blade files that structure your frontend pages.
  • - core/storage/ contains log files, cache data, and generated session details (must be writable).
• install/: Initial installation resources containing the MySQL database structure backups and configurations.
• .htaccess: Apache redirection rules ensuring all requests are directed to `index.php` for Laravel routing.
• index.php: The entry point of the application, connecting the web server requests to Laravel's bootstrap logic inside `core/`.
• Third-party libraries (source form): Every bundled JavaScript and CSS library ships as its full, readable, original source — there are no .min.js or .min.css files anywhere in this package. Each library sits at its normal path and is the file the application actually loads, so what you read is exactly what runs. For example assets/global/js/bootstrap.bundle.js is Bootstrap's official unminified distribution, and assets/global/js/jquery-3.7.1.js is the official uncompressed jQuery build. You can open, read, debug and step through any of them directly in your browser's developer tools. assets/admin/js/fontawesome-iconpicker.js is the plugin author's original source files (src/js/jquery.ui.pos.js and src/js/iconpicker.js), with the default icon list extended to include the Line Awesome set alongside Font Awesome 5. The package also contains no node_modules or vendor folder: PHP dependencies are installed with composer install (see the Installation section), and no npm/build step is required — the front-end assets above are loaded directly by the browser.
• Firebase SDK: the Firebase JavaScript SDK v7.23.0 is not bundled into the package at all — it is loaded straight from Google's official CDN (https://www.gstatic.com/firebasejs/7.23.0/), referenced in core/resources/views/partials/push_script.blade.php and assets/global/js/firebase/firebase-messaging-sw.js. Firebase Cloud Messaging is a network service, so the SDK is fetched over the internet in the same way the notifications themselves are delivered. Everything inside assets/global/js/firebase/ is OvoCheckout's own plain, readable JavaScript — the service worker and your configs.js credentials file. See assets/global/js/firebase/README.txt for setup notes.

The following external services can be integrated with OvoCheckout. Each is independent, and the crypto/fiat gateways are only needed if you intend to accept those specific payment types.

Follow the steps:

1. Access Your Hosting Control Panel: Log in to your hosting control panel (e.g., cPanel, Plesk, or VPS terminal access).
2. Open the Cron Jobs Section: Find and click on the Cron Jobs option under Advanced or Tools section.
3. Create a New Cron Job: Choose a time interval (recommended: every 1 minute) and go to the your admin dashboard and copy following command.
   
4. Save and Activate: Click the Save or Add New Cron Job button. Your scheduled tasks are now automated.
5. Test It: Navigate to the Cron Job Settings section from your admin dashboard to monitor and verify if the cron jobs are running correctly by reviewing the execution logs.

Part A — Create a Backup (Export)

1. Log in to your hosting control panel (for example cPanel) and open phpMyAdmin. On a local server, open http://localhost/phpmyadmin.
2. In the left-hand list, click your OvoCheckout database name (the same name set in your core/.env file next to DB_DATABASE).
3. Click the Export tab at the top of the page.
4. Leave the export method on Quick and keep the format as SQL, then click Go (or Export).
5. Your browser downloads a single .sql file. Save it somewhere safe (and ideally a second copy in cloud storage). Naming it with the date, e.g. ovocheckout-backup-2026-07-23.sql, makes it easy to find later.

Part B — Restore a Backup (Import)

1. Open phpMyAdmin and select the database you want to restore into. For a clean restore, first select all existing tables and choose Drop (delete) them, or create a fresh empty database.
2. Click the Import tab at the top.
3. Click Choose File, select your saved .sql backup file, then click Go.
4. Wait for the success message. Your data is now restored. If you moved to a new server, make sure core/.env points to the correct database name, username, and password.

1. API Credentials & Authentication

All requests sent to the OvoCheckout API must be authenticated. You must obtain your credentials and authorize your server's IP address:

1. Get API Credentials: Log in to your OvoCheckout User Dashboard and navigate to Developer Tools to obtain your unique client-id and client-secret.
2. Headers: Include client-id and client-secret inside the headers of every HTTP request.
3. IP Whitelisting (Crucial Security): For extra security, OvoCheckout enforces server-to-server IP validation. You must add your external website server's public IP address to the IP Whitelist in the dashboard. Requests from an IP that is not on the list are rejected with HTTP 401, remark Unauthorized and the message "Your ip address is not valid".

2. Base API URL

All endpoints use the following base path: https://yourdomain.com/api

3. Main API Endpoints

Below is an overview of the core developer endpoints:

• Check Connection: GET /api - Send a ping request to verify if the API is working. Returns a pong success message.
• Retrieve Supported Currencies: GET /api/supported-currencies - Returns active fiat and crypto currencies configured in your payment system.
• Initiate Checkout / Create Invoice: POST /api/payment-initiate - Main endpoint to create a payment request.
  Required POST fields: amount, currency_code, merchant_trx (unique reference), success_url, failed_url, ipn_url, description.
  Returns: Invoice details and a payment_link. You should redirect your buyer to this payment_link to let them complete their payment on the checkout page.
• Verify Invoice Status: GET /api/invoice-status/{invoice_id} - Check if an invoice is paid, unpaid, partially paid, or expired.

4. Instant Payment Notification (IPN) Webhooks

When a payment is successfully completed, the platform sends a secure, server-to-server HTTP POST request to the ipn_url specified during transaction initiation.

Sample IPN POST JSON Payload:

{
    "status": "success",
    "payment_status": "success",
    "invoice_status": "paid",
    "type": "crypto",
    "name": "Customer Name",
    "email": "[email protected]",
    "data": {
        "invoice_id": "INV-XYZ123",
        "trx": "TX-ABC-123456",
        "merchant_trx": "ORDER_9988",
        "amount": "50.00",
        "method": "PayPal",
        "currency": {
            "code": "USD",
            "name": "US Dollar"
        },
        "date": "2026-07-18 12:00:00"
    }
}

5. Interactive API Documentation Guide

Your OvoCheckout installation comes with a built-in, fully interactive developer documentation page! Once installed, you can access detailed endpoint testing, cURL request schemas, validation attributes, and sample responses directly on your server at:
https://yourdomain.com/api-documentation
(replace yourdomain.com with your own domain - this page is served by your own installation, so there is nothing to visit until you have installed OvoCheckout.)

6. Common API Response & Error Codes

Every API response returns a JSON body containing a remark (machine-readable code), a status (success or error), a message array, and an optional data object. Use the remark value and the HTTP status code together to handle responses in your integration. The most common codes are listed below.

A typical error body looks like this - note that message is a flat array of strings, so join it or show the first element:

{
    "remark": "validation_error",
    "status": "error",
    "message": [
        "The amount field is required.",
        "The currency code field is required."
    ]
}

And an authentication failure, which does carry an HTTP status code:

{
    "remark": "Unauthorized",
    "status": "error",
    "message": [
        "Your ip address is not valid"
    ]
}

Building a mobile app? See the Troubleshooting API Responses section of the mobile app documentation for app-side handling of these responses.

Email Us: [email protected]