Skip to main content

Getting Stared

1.1 Overview​

OxPay enables merchants to accept payments seamlessly through multiple channels, including online, in-store, and mobile platforms.
Before you begin, please ensure that your merchant account has been successfully activated.

1.2 Prerequisites​

Before starting the integration, make sure you have the following:

OxPay Merchant Account
MID, TID, and API document
OxPay Merchant Portal Access
Basecamp Channel to support technical questions

1.3 Integration Steps​

  1. Obtain API credentials from the OxPay Merchant Portal.
  2. Review the relevant API documentation or integration guide.
  3. Set up a live test environment for transaction validation.
  4. Perform end-to-end testing of payment flows.
    • OxPay will provide test cases to the Merchant.
  5. Submit results to OxPay for verification.
  6. Go live upon approval from OxPay’s technical team.

1.4 Support and Resources​

Documentation: https://docs.oxpayfinancial.com/api-reference/
Support Email: support@oxpayfinancial.com

Available APIs​

OxPay provides a set of APIs to facilitate payment processing and integration.
The full API documentation can be accessed here: OXPAY API

Merchant Integration Options​

1) Get Hosted Payment Page (Gateway Hosted)​

Payer is redirected to OxPay’s secure hosted payment page.
Simplifies integration and ensures PCI compliance.
Best for merchants who want an easy and secure setup.

2) Create Payment (Merchant Hosted)​

Merchant collects payment details on their own website/app.
Merchant calls OxPay APIs directly.
Provides more control over the user experience.
Requires PCI DSS compliance.

Merchants can integrate the following methods and APIs into their system based on their requirements.

User Experience Flow​

The payment flow for customers differs depending on the integration method chosen:

Hosted Payment Page (Gateway Hosted)​

  1. Payer initiates checkout on the merchant’s website.
  2. Gateway-hosted payment page is displayed.
  3. The payer selects the payment option under Payment Methods and completes the payment.
    • Scan the QR code and complete the payment within the mobile app.
    • If it’s a card payment, enter your card details and complete the transaction on the OxPay Secure Payment Page.
  4. OxPay sends a payment status response back to the merchant system.
  5. Payment process is completed.

Merchant Hosted (Create Payment)​

  1. Payer initiates checkout on the merchant’s website/app.
  2. Merchant collects payment details directly.
  3. Merchant calls OxPay’s Create Payment API to process the payment.
  4. OxPay validates and processes the payment request.
  5. OxPay returns payment status response to the merchant.
  6. Payment process is completed.

Portal Usage Guide​

Refer to the attached Portal Usage Guide for detailed steps on accessing and managing your OxPay Merchant Portal.

Topics​

OxPay Lite Usage Guide​

Refer to the attached OxPay Lite Usage Guide for using the OxPay Lite application.
Document: OxPay Lite User Guide

2. End-to-End Process​

The full end-to-end process for merchant onboarding and integration with OxPay is as follows:

  1. Merchant signs up.
  2. Merchant onboarding begins.
  3. Integration starts (dependent on credentials provided by OxPay).
  4. Merchant can proceed with implementation while onboarding continues.
  5. Merchant receives credentials via email.
  6. Merchant completes deployment.
  7. Merchant proceeds with production testing (note: no UAT environment available).
  8. Merchant executes test cases.
  9. Merchant confirms Go-Live.