App Income & Ledger

Your App income from Transaction Costs, From Loans Fees and Your Income Wallet Balances and Actions.

FINANCIALS AND ANALYTICS

1. App Income

The App Income section provides app owners with the ability to track income generated from transaction costs. A percentage of the transaction costs is allocated to the app, and this income is deposited into the app's wallet or account daily. This feature enables transparency and easy management of funds.

Key Features:

  • Track income generated from transaction costs.

  • View app wallet balances in real-time.

  • Withdraw or transfer funds from the wallet.


Endpoints for App Income

1.1 Retrieve Wallet Balance

Fetches the current wallet balance for an app.

Method

GET

URL

/api/financials/wallet-balance

Request Body:

{
  "appId": "app123"
}

Response:

{
  "status": "success",
  "walletBalance": 15000.50,
  "currency": "KES"
}

1.2 Withdraw Funds from Wallet

Allows app owners to withdraw or transfer funds from their wallet.

Method

POST

URL

/api/financials/withdraw

Request Body:

{
  "appId": "app123",
  "amount": 5000,
  "destinationAccount": "bankAccount001"
}

Response:

{
  "status": "success",
  "message": "Withdrawal of 5000 KES successful.",
  "transactionId": "txn78901"
}

2. App Ledger

The App Ledger provides a detailed record of all transactions related to the app, including income from transaction costs. App owners can review summaries and details of their transactions. For privacy, sensitive information such as phone numbers and names can be masked. Full visibility of this information can be requested where necessary.


Sample Table: App Ledger

Transaction ID

Date

Type

Description

Amount (KES)

Transaction Cost

Contact

txn001

2024-12-18

Send Money

Payment to Jane

5,000.00

50.00

+254***1234

txn002

2024-12-18

Bulk Payment

Salary disbursement

100,000.00

1,000.00

+254***5678

txn003

2024-12-17

Lipa Karo

School fee payment

15,000.00

150.00

+254***9101

txn004

2024-12-17

Deposit

Wallet top-up

20,000.00

0.00

-

txn005

2024-12-16

Send Money

Payment to John

2,000.00

20.00

+254***1122

txn006

2024-12-15

Bulk Payment

Scholarship disbursement

50,000.00

500.00

+254***3344

txn007

2024-12-14

Lipa Karo

Tuition fee payment

25,000.00

250.00

+254***5566

txn008

2024-12-13

Send Money

Church donation

10,000.00

100.00

+254***7788

txn009

2024-12-13

Deposit

Wallet top-up

5,000.00

0.00

-

txn010

2024-12-12

Bulk Payment

Staff allowances

30,000.00

300.00

+254***9900


Endpoints for App Ledger

2.1 Retrieve Ledger Entries

Lists all transactions for an app, including transaction costs and summaries.

Method

GET

URL

/api/financials/ledger

Request Body:

{
  "appId": "app123",
  "filter": {
    "startDate": "2024-12-01",
    "endDate": "2024-12-31"
  }
}

Response:

{
  "status": "success",
  "ledgerEntries": [
    {
      "transactionId": "txn001",
      "date": "2024-12-18",
      "type": "Send Money",
      "description": "Payment to Jane",
      "amount": 5000.00,
      "transactionCost": 50.00,
      "maskedContact": "+254***1234"
    },
    {
      "transactionId": "txn002",
      "date": "2024-12-18",
      "type": "Bulk Payment",
      "description": "Salary disbursement",
      "amount": 100000.00,
      "transactionCost": 1000.00,
      "maskedContact": "+254***5678"
    }
  ]
}

2.2 Request Full Contact Visibility

Enables app owners to request full visibility of masked contact information.

Method

POST

URL

/api/financials/request-visibility

Request Body:

{
  "appId": "app123",
  "transactionId": "txn001"
}

Response:

{
  "status": "success",
  "message": "Request for visibility submitted. Awaiting approval."
}

Additional Notes

  1. Income Tracking: App owners can easily monitor the income generated from transaction costs.

  2. Ledger Overview: The ledger provides a comprehensive view of all transactions, with privacy options for sensitive data.

  3. Withdrawals: Wallet funds can be withdrawn or transferred seamlessly.

  4. Visibility Requests: Ensure compliance and security when requesting full visibility of contact information.

Last updated