Partner API

Comprehensive APIs for wallet management, transaction processing, and bulk operations. Designed specifically for third-party partners and integrators.

Get Started
Try SandboxComing Soon

Key Features

Built for scale, security, and developer experience

Secure API Keys

Bank-grade security with encrypted API keys and comprehensive access controls

Real-Time Processing

Instant transaction processing with real-time status updates and webhooks

Partner Management

Comprehensive partner account management with granular permissions

Developer Friendly

RESTful APIs with comprehensive documentation and SDKs

External Wallet APIs

APIs for external partners to manage wallets, check balances, and view transaction summaries

External Wallet APIs

APIs for external partners to manage wallets, check balances, and view transaction summaries

/partner/v1/wallet

Transact APIs

Process various transaction types including wallet-to-wallet, mobile money, and bank transfers

Transact APIs

Process various types of transactions including wallet-to-wallet, mobile money, and bank transfers

/partner/v1/transactions

Bulk Operations

Efficiently process multiple transactions in a single batch for payroll and bulk payments

Bulk Transactions

Process multiple transactions in a single batch for efficiency

/partner/v1/transactions/bulk

Code Examples

Get started quickly with these practical examples

Authentication

All requests require an API key in the Authorization header

curl -X GET "https://api.rukapay.co.ug/partner/v1/wallet/me" \
  -H "Authorization: Bearer ak_live_your_api_key_here" \
  -H "Content-Type: application/json"

Get Wallet Information

Retrieve wallet details for a user

curl -X GET "https://api.rukapay.co.ug/partner/v1/wallet/me?userId=user_123456789" \
  -H "Authorization: Bearer ak_live_your_api_key_here" \
  -H "Content-Type: application/json"

Process Transaction

Send funds from wallet to mobile money

curl -X POST "https://api.rukapay.co.ug/partner/v1/transactions/transact" \
  -H "Authorization: Bearer ak_live_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "userId": "user_123456789",
    "mode": "WALLET_TO_MNO",
    "amount": 50000,
    "currency": "UGX",
    "description": "Payment for services",
    "phoneNumber": "+256700000001",
    "mnoProvider": "MTN"
  }'

Bulk Transaction

Process multiple transactions in a single batch

curl -X POST "https://api.rukapay.co.ug/partner/v1/transactions/bulk" \
  -H "Authorization: Bearer ak_live_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "userId": "user_123456789",
    "batchReference": "salary_payment_2024_01",
    "mode": "WALLET_TO_MNO",
    "currency": "UGX",
    "description": "Monthly salary payments",
    "items": [
      {
        "referenceId": "emp_001",
        "amount": 500000,
        "description": "Salary - John Doe",
        "phoneNumber": "+256700000001",
        "mnoProvider": "MTN"
      }
    ]
  }'

Transaction Modes

Comprehensive support for various transaction types with clear requirements and examples

Wallet to Wallet

active

Transfer funds between Rukapay wallets

Mandatory Fields:

senderUserIdrecipientUserIdamountcurrency
View Details

Wallet to Mobile Money

active

Send funds from wallet to mobile money accounts

Mandatory Fields:

userIdamountphoneNumbermnoProvider
View Details

Mobile Money to Wallet

active

Top up wallet from mobile money

Mandatory Fields:

userIdamountphoneNumbermnoProvider
View Details

Bank Transfer

beta

Transfer funds to bank accounts

Mandatory Fields:

userIdamountbankCodeaccountNumber
View Details

Merchant Payment

active

Pay merchants and service providers

Mandatory Fields:

userIdamountmerchantIddescription
View Details

Wallet Top-up

active

Add funds to wallet from external sources

Mandatory Fields:

userIdamountpaymentMethodcurrency
View Details

Ready to Integrate?

Start building with our Partner API today. Get your API keys and begin integration in minutes.

Get API Keys
Try SandboxComing Soon