TIPMAS Payment Gateway

Integration Guide for G-24Cs Partners

A step-by-step guide for GESFP, APMIS, GLPC, and all G-24Cs member programs to integrate with the TIPMAS payment gateway.

G-24Cs Member Companies

Select your company to begin the integration process. All 24 members are eligible.

Supported Inbound Collection Methods

TIPMAS gateway accepts payments from the following methods. All settlements are in UGX (Ugandan Shillings) by default; USDT settlements available on request.

MTN MoMo

Mobile money collection via MTN Uganda

Airtel Money

Mobile money collection via Airtel Uganda

Bank Transfer

Direct bank deposits to HDD collector accounts

USDT (Multi-chain)

Tron, BSC, Polygon, Ethereum USDT deposits

Settlement currency: UGX (default) or USDT. Partners select their preferred settlement currency during registration. Commission is deducted in the same currency as the charge.

Sandbox / Test Environment

Test your integration safely before going live. Sandbox keys use the tgp_test_ prefix and process simulated transactions.

Sandbox API Key: Toggle "Sandbox / Test Mode" during registration to receive a tgp_test_… key.

Test Charges: Call gatewayCharge with any amount — no real funds move.

Test Webhooks: Use the "Test" button on your Partner Dashboard to send a sample payload to your webhook URL.

Go Live: Contact a TIPMAS admin to activate your live account and receive a tgp_live_… key.

Step-by-Step Integration

1

Register Your Program

Visit the Partner Registration page and fill in your program name, code, category, contact email, and webhook URL. You can select your G-24Cs company from the list above.

Go to Registration
2

Receive Your API Key

Upon registration, you instantly receive a full-access API key (tgp_live_...). Store it securely — it is shown only once. Your account starts in "pending" status until an admin activates it.

3

Admin Activation

A TIPMAS admin reviews and activates your partner account. You will receive an email notification once activated. Until then, API calls will return a 403 error.

4

Make Your First Charge

Once activated, call the gatewayCharge endpoint with your API key in the x-tipmas-gateway-key header. Commission (default 2%) is auto-calculated and deducted from the transaction.

5

Set Up Webhooks

Configure your webhook URL in the partner settings. TIPMAS will POST event payloads (charge.completed, settlement.completed, refund.completed) to your endpoint for real-time updates.

6

Request Settlements

When ready, call gatewaySettle to request a payout of your outstanding balance. Settlements are processed and your partner balance is adjusted automatically.

API Reference

All endpoints require the x-tipmas-gateway-key header

POST/functions/gatewayCharge

Process a charge for a customer. Commission is auto-calculated and deducted.

curl -X POST https://api.tipmas.co/functions/gatewayCharge \
  -H "x-tipmas-gateway-key: tgp_live_xxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 50000,
    "currency": "UGX",
    "customer_email": "user@example.com",
    "customer_phone": "+256700000000",
    "description": "GESFP membership fee",
    "reference": "gesfp_001"
  }'
Response:
{
  "success": true,
  "transaction_id": "gtx_abc123",
  "status": "completed",
  "amount": 50000,
  "fee_amount": 1000,
  "net_amount": 49000
}
POST/functions/gatewaySettle

Request a settlement payout of your outstanding balance.

curl -X POST https://api.tipmas.co/functions/gatewaySettle \
  -H "x-tipmas-gateway-key: tgp_live_xxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 100000,
    "settlement_account_id": "acct_001",
    "reference": "monthly_settlement"
  }'
POST/functions/gatewayRefund

Refund a previously processed charge. Partner balances are adjusted automatically.

curl -X POST https://api.tipmas.co/functions/gatewayRefund \
  -H "x-tipmas-gateway-key: tgp_live_xxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "original_transaction_id": "gtx_abc123",
    "reason": "Customer request"
  }'
POST/functions/gatewayQuery

Query transaction status, your partner balance, or recent transaction history.

# Check transaction status
curl -X POST https://api.tipmas.co/functions/gatewayQuery \
  -H "x-tipmas-gateway-key: tgp_live_xxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{ "action": "status", "transaction_id": "gtx_abc123" }'

# Check your balance
curl -X POST https://api.tipmas.co/functions/gatewayQuery \
  -H "x-tipmas-gateway-key: tgp_live_xxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{ "action": "balance" }'

# Get recent transactions
curl -X POST https://api.tipmas.co/functions/gatewayQuery \
  -H "x-tipmas-gateway-key: tgp_live_xxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{ "action": "history", "limit": 20 }'
Balance response:
{
  "partner_id": "gwp_g24cs-01_xxx",
  "partner_name": "Mega Teams Agency",
  "status": "active",
  "settlement_currency": "UGX",
  "total_processed": 500000,
  "total_commission": 10000,
  "total_settled": 200000,
  "outstanding_balance": 290000
}

Webhook Events

Configure a webhook URL in your partner settings. We'll POST event payloads to your endpoint with an X-TIPMAS-Signature header containing an HMAC-SHA256 signature of the request body:

charge.completedsettlement.completedrefund.completed

Verify webhook authenticity by checking the signature header:

// Your webhook handler (Node.js)
const crypto = require('crypto');

const signature = req.headers['x-tipmas-signature']; // "sha256=<hex>"
const rawBody = JSON.stringify(req.body); // exact body received

const expected = 'sha256=' + crypto
  .createHmac('sha256', YOUR_WEBHOOK_SECRET)
  .update(rawBody)
  .digest('hex');

if (signature !== expected) {
  return res.status(401).send('Invalid signature');
}

Your signing secret (whsec_…) is generated at registration. Failed webhooks are automatically retried every 10 minutes for up to 24 hours.

{
  "event": "charge.completed",
  "transaction_id": "gtx_abc123",
  "partner_id": "gwp_gesfp_official",
  "amount": 50000,
  "currency": "UGX",
  "fee_amount": 1000,
  "net_amount": 49000,
  "status": "completed",
  "timestamp": "2026-07-12T08:00:00.000Z"
}

Ready to integrate?

Register your G-24Cs program now and receive your API key instantly.

Register & Get API Key

TIPMAS Payment Gateway · Herman Development Depository · Synapse IT · G-24Cs

Powered by Mollies Coin (MOL) · Absolute Data Sovereignty