Ubupay Documentation
  1. Overview
Ubupay Documentation
  • Overview
    • Introduction
    • Getting started
  • Agent API Documentation
    • Introduction
    • Authentication
      • Agent authentication
      • OTP Request
      • OTP Verification
      • Password reset
    • Profile management
      • Create agent business profile
      • Update agent business profile
      • Retrieve agent business profile
      • Agent profile
    • Transactions
      • Transfers list
      • Transactions status amount
      • Transactions status count
      • Update transaction status
  1. Overview

Getting started

Account Setup#

Before you can make API requests, you need to sign up for a Ubupay merchant account.
1.
Visit https://ubupay.ca/ and click on "Sign Up" or "Get Started."
2.
Complete the registration process, providing all necessary business and contact information.
3.
Once your account is approved, you will gain access to your Ubupay Merchant Dashboard, where you can manage your account, view transactions, and retrieve your API credentials.

API Credentials#

Your API credentials are essential for authenticating your requests to the Ubupay API.
You will be using your username and password to get the authentication Token to authenticate all the endpoints.

Environments#

Ubupay provides two environments for development and testing:
Sandbox Environment: Use this environment for development and testing without affecting live transactions. Payments processed in the Sandbox are simulated.
Base URL (Sandbox): https://sandbox.ubupay.ca/v1
Production Environment: This environment is for processing live transactions with real money.
Base URL (Production): https://api.ubupay.ca/v1
The two environment are set up by Ubupay team. You can get in touch to have access to sandbox. After testing validation, a production environment will be then set up.
Always ensure you are using the correct API credentials and base URL for the environment you are working in.

Authentication#

All requests to the Ubupay API must be authenticated. We use a token-based authentication mechanism.
Method: Include your API Key in the Authorization header of each request.
Example Header: Authorization: Bearer AUTH_ACCESS_TOKEN
More detailed authentication will be covered in a dedicated "Authentication" section in the API Reference section
Modified at 2025-06-03 05:11:02
Previous
Introduction
Next
Introduction
Built with