Wallet balance improvement and deferred mobile money collection

Author: jilenloa

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 jilenloa
+Copyright (c) 2023 jilenloa
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -9,6 +9,7 @@ This library makes it easy for PHP developers to integrate with One4All TPP onli
 
 It's supported on PHP 5.5+
 
+## Using the Library
 ```php
 use MyOne4All\TppClient;
 use MyOne4All\Exceptions\TppException;
@@ -17,16 +18,33 @@ use MyOne4All\NetworkCodes;
 
 $tppClient = new TppClient("apikey", "apisecret", "retailer");
 
+```
+
+## Get Balance
+```php
+# ecredit balance
 echo $tppClient->getBalance(); # 0.0
 
+# mobile money collection balance
+echo $tppClient->getBalance(TppClient::WALLET_TYPE_MOBILE_MONEY_COLLECTION); # 0.0
+
+# mobile money credit balance
+echo $tppClient->getBalance(TppClient::WALLET_TYPE_MOBILE_MONEY_CREDIT); # 0.0
+```
+
+## Send Airtime
+```php
 // send airtime implementation
 $airtime_response = $tppClient->sendAirtime("0245667942", 1, "trans03423423", NetworkCodes::AUTO_DETECT);
 if($airtime_response->isSuccessful()){
     echo "airtime sent";
 }else{
     echo "Failed: ".$airtime_response->getErrorMessage();
 }
+```
 
+## Send Data Bundle
+```php
 // send internet data implementation
 $data_code = "DAILY_20MB";
 $transaction_reference = "trans03423423";
@@ -36,7 +54,24 @@ if($bundle_response->isSuccessful()){
 }else{
     echo "Failed: ".$bundle_response->getErrorMessage();
 }
+```
+
+## Send Flexi Data Bundle
+```php
+// send internet data implementation
+$data_code = "flexi_data_bundle";
+$transaction_reference = "trans03423423";
+$amount = 10;
+$bundle_response = $tppClient->sendFlexiDataBundle("0245667942", $amount, $data_code, $transaction_reference, NetworkCodes::MTN_GH);
+if($bundle_response->isSuccessful()){
+    echo "internet bundle sent";
+}else{
+    echo "Failed: ".$bundle_response->getErrorMessage();
+}
+```
 
+## Send Mobile Money
+```php
 
 // send mobile money implementation
 $transaction_reference = "trans03423423";
@@ -51,7 +86,10 @@ if($momo_response->isSuccessful()){
 }else{
     echo "Failed: ".$momo_response->getErrorMessage();
 }
+```
 
+## Receive Mobile Money
+```php
 // receive mobile money implementation
 $transaction_reference = "trans03423423";
 $amount = 1;
@@ -63,7 +101,27 @@ if($momo_response->isSuccessful()){
 }else{
     echo "Failed: ".$momo_response->getErrorMessage();
 }
+```
+## Receive Mobile Money on USSD
+When working with USSD sessions, it is important there is a delay between the closing of the current session and the payment prompt. Use the delay parameter to specify the number of seconds to delay the payment prompt after the current USSD session ends.
+```php
+// receive mobile money implementation
+$transaction_reference = "trans03423423";
+$amount = 1;
+$payer_number = "0245667XXX";
+// the last parameter represents the number of seconds to delay the payment prompt
+$momo_response = $tppClient->receiveMobileMoney($payer_number, $amount, $transaction_reference, 5);
+if($momo_response->isSuccessful()){
+    // check transaction status later to confirm receipt
+    echo "mobile money payment request initiated";
+}else{
+    echo "Failed: ".$momo_response->getErrorMessage();
+}
+```
+
+## Send SMS
 
+```php
 $sms_message = "hello world";
 $sms_sender_id = "One4All";
 $transaction_reference = "sms11";
@@ -74,7 +132,11 @@ if($sms_response->isSuccessful()){
     echo "Failed: ".$sms_response->getErrorMessage();
 }
 
+```
 
+## Query Bundle List
+We recommend you cache this list for at least 24 hours to avoid unnecessary API calls.
+```php
 
 echo NetworkCodes::AUTO_DETECT; # 0
 echo NetworkCodes::MTN_GH; # 4

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "jilenloa/tppmyone4all-php",
     "description": "PHP Library to integration myone4all tpp service easily",
-    "version": "0.0.6",
+    "version": "1.0.0",
     "type": "library",
     "license": "MIT",
     "authors": [

src/NetworkCodes.php

@@ -13,10 +13,18 @@ class NetworkCodes
 {
     const AUTO_DETECT = 0;
 
+    /**
+     * @deprecated
+     */
     const AIRTEL_GH = 1;
+    const AT_GH = 1;
     const EXPRESSO_GH = 2;
     const GLO_GH = 3;
     const MTN_GH = 4;
+
+    /**
+     * @deprecated
+     */
     const TIGO_GH = 5;
     const VODAFONE_GH = 6;
 

src/TppClient.php

@@ -25,6 +25,9 @@ class TppClient
 
     const COUNTRY_GHANA = 'gh';
     const COUNTRY_CONGO = 'drc';
+    const WALLET_TYPE_ECREDIT = 'e-credit';
+    const WALLET_TYPE_MOBILE_MONEY_CREDIT = 'mobile-money-credit-account';
+    const WALLET_TYPE_MOBILE_MONEY_COLLECTION = 'mobile-money-collection-account';
 
     /**
      * Client constructor.
@@ -71,8 +74,8 @@ private function getHttpClient(){
      * @return string|double
      * @throws ClientException
      */
-    public function getBalance(){
-        $response = $this->getHttpClient()->get("/api/TopUpApi/balance");
+    public function getBalance($wallet_type = self::WALLET_TYPE_ECREDIT){
+        $response = $this->getHttpClient()->get("/api/TopUpApi/balance?type={$wallet_type}");
         $response_array = json_decode($response->getBody()->getContents(), true);
         return $response_array['balance'];
     }
@@ -119,6 +122,21 @@ public function sendDataBundle($recipient, $data_code, $transaction_reference, $
         return new TppResponse($response_array);
     }
 
+    public function sendFlexiDataBundle($recipient, $amount, $data_code, $transaction_reference, $network){
+        $params = array(
+            'retailer' => $this->retailer,
+            'recipient' => $recipient,
+            'data_code' => $data_code,
+            'network' => $network,
+            'trxn' => $transaction_reference,
+            'amount' => $amount
+        );
+
+        $response = $this->getHttpClient()->get("/api/TopUpApi/dataBundle?".http_build_query($params));
+        $response_array = json_decode($response->getBody()->getContents(), true);
+        return new TppResponse($response_array);
+    }
+
     /**
      * @param $recipient
      * @param $amount
@@ -141,15 +159,20 @@ public function sendMobileMoney($recipient, $amount, $transaction_reference){
      * @param $payer_number
      * @param $amount
      * @param $transaction_reference
+     * @param int $delay_seconds
      * @return TppResponse
      * @throws ClientException
      */
-    public function receiveMobileMoney($payer_number, $amount, $transaction_reference){
+    public function receiveMobileMoney($payer_number, $amount, $transaction_reference, $delay_seconds = 0){
         $params = array(
             'amount' => $amount,
             'recipient' => $payer_number,
             'trxn' => $transaction_reference
         );
+
+        if($delay_seconds && $delay_seconds > 0){
+            $params['delay'] = $delay_seconds;
+        }
         $response = $this->getHttpClient()->get("/api/TopUpApi/c2b?".http_build_query($params));
         $response_array = json_decode($response->getBody()->getContents(), true);
         return new TppResponse($response_array);