Do you manage money on behalf of third parties ?

Creating Wallets  

const walletPromise = 
    fPay.wallet.create({
        name: "Magasin Yopougon"
    });
const walletPromise = 
    fPay.wallet.create({
        name: "Magasin Cocody"
    });
const walletPromise = 
    fPay.wallet.create({
        name: "Magasin San-Pedro"
    });

const walletPromise = 
    fPay.wallet.create({
        name: "Compte Entreprise #1"
    });
const walletPromise = 
    fPay.wallet.create({
        name: "Compte Entreprise #2"
    });
const walletPromise = 
    fPay.wallet.create({
        name: "Compte Entreprise #3"
    });

Money in to a Wallet  

Destination  

Whenever money is added to your account, the funds collected will be deposited in your main  Wallet  by default. Because you can create several additional  Wallet , you can also choose where the funds arrives once the user has paid.
So, you can have one  Wallet  for your savings, or one Wallet per store if you have several stores, and choose where the funds received will go.

How it works ?

To specify the destination of the funds, you need the MARS of the  Wallet, available vie the mars.alpha field.
For example, if the Wallet's MARS is "CI FPay W09POT", then you would enter the following code:

const depositPromise = 
    fPay.deposit.initiate({
        destination: "CI FPay W09POT",
        source: {
            _type: "Single",
            account: {
                country: "CI",
                identifier: "+2250100000000",
                providerKey: "MoovMoney"
            }
        },
        amount: {
            currency: "XOF",
            value: "10_000"
        }
    });

Transferring Money between Wallets  

You can move money between any Wallet you own. You can withdraw money from your Wallet and deposit it in your user's Wallet, and vice versa. These account movements can even correspond to users you have paying each other.
Also, if in the course of your business you need to receive deposits from your users, you can store these deposits in their respective Wallets. Later, you can deduct from this deposit the amounts corresponding to offences they have committed by making a Transfer to your Wallet or, if no offence has been committed, you can initiate a refund to their mobile money wallets directly from their Wallet : the possibilities are endless and your choice will depend on your activity.

How it works ?

Let's say you own a Wallet whose MARS is "CI FPay MPO099R" and another Wallet whose MARS is "CI FPay MOY67RT". To transfer money from the first Wallet to the second, you need to do the following code:

const transferPromise = 
    fPay.transfer.initiate({
        amount: "10_000 XOF",
        source: "CI FPay MPO099R",
        destination: "CI FPay MOY67RT"
    });

Money out from a Wallet  

For all outgoing payments, the funds sent will be taken from your main  Wallet  by default. If the cash outflow is for a specific customer, because you have the option of telling FPay the  Wallet  from which the money is to be taken for this cash outflow, you can specify the  Wallet  of the customer concerned by this cash outflow, regardless of whether this cash outflow is made via a Transfer  object or a QuasiTransfer object.

How it works ?

To specify the source of the funds, you need the MARS of the  Wallet, available vie the mars.alpha field.
For example, if the Wallet's MARS is "CI FPay W09POT", then you would enter the following code:

const transferPromise = 
    fPay.transfer.initiate({
        amount: {
            currency: "XOF",
            value: "10_000"
        },
        source: "CI FPay W09POT",
        destination: {
            _type: "Single",
            account: {
                country: "CI",
                identifier: "+2250100000000",
                providerKey: "MoovMoney"
            }
        }
    });

const quasiTransferPromise = 
    fPay.quasiTransfer.initiate({
        amount: {
            currency: "XOF",
            value: "10_000"
        },
        source: "CI FPay W09POT"
    });

Drawing up a statement of transactions  

Let's suppose it's October 27th (10/27) and we want to draw up a statement for a customer showing the Transaction that have taken place in his Wallet since the 1st of the month to date. The result could look like the following figure :

Let's see how to build this previous table for each of your customers

A word about the Transaction object

Everytime there is a change in the balance of a Wallet, a Transaction object is created to materialize this movement of money. Whether this change in balance is due to a Transfer, a Deposit or any other object, a Transaction object will be created. So, to create the above table, here are the Transaction object fields that will be useful to us:

•   amount
  With an always positive value, this field represents the amount that has been added to or withdrawn from the Wallet in question.
•   dc
  Abbreviation for debit or credit, this field indicates whether the previous amount has been added to or withdrawn from the Wallet in question.
  The 2 possible values for this field are "Debit" or "Credit".
  If the value is "Debit", then the amount that is always positive has been removed from the Wallet.
  If the value is "Credit", then the amount that is always positive has been added to the Wallet.
•   wallet
  This field is an indicator of the status of the target Wallet on which the Transaction took place. In particular, this field will give us access to the balance before and after the Transaction.
•   status
  This field indicates whether the transaction was successful or failed. The 2 possible values for this field are Successful or Failure.
  Please note that these are not String, but objects. For example, the Failure object has isCancelled field, which indicates that the transaction failed because it has was cancelled.
•   parent
  This field indicates the parent object whose execution led to the creation of this Transaction. This parent object can therefore be a Transfer, Deposit, QuasiTransfer etc.
•   details
  This field, if available, will access the transaction id generated by the operator if this transaction concerns an operation between FPay and the outside world (Mtn Money, Orange Money or Moov Money).

Implementation

Now that we've set the scene, we will :

•  List all successful Transaction in the current month for the user's Wallet. Let's assume that the user's wallet id is 123456789.
•   Extract for each Transaction the information required to build the table.

List all successful Transaction in the current month

const transactionsCollectionPromise = 
    fPay.transaction.list({
        filter: "status = 'Successful'"
                + " AND createdTime in CurrentMonth"
                + " AND wallet.id = '123456789'",
        sortBy: "createdTime:ASC"
    });

//  Access items in the returned collection, page per page
let transactionsCollection = await transactionsCollectionPromise;
let allTransactions = transactionsCollection.toArray();
while(transactionsCollection.hasNextPage()){
    transactionsCollection = 
        await fPay.transaction.fetchPage(transactionsCollection.pagination.nextPage);
    const transactions = transactionsCollection.toArray();
    allTransactions = allTransactions.concat(transactions);
}

Extract for each Transaction the information required to build the table

let debitTransactionsAmount = [];
let creditTransactionsAmount= [];
for (const transaction of allTransactions) {
    const date = new Date(transaction.createdTime.iso8601); 
    const dayOfMonth = date.getDate(); 
    const month = date.getMonth(); 
    const details = transaction.h1.fr; 
    const beforeBalance = transaction.wallet.before.balance.available; 
    const afterBalance = transaction.wallet.after.balance.available; 
    let debitAmount = null;
    if(transaction.dc.isDebit()){
        // amount is always positive so we have to negate the value for debit 
        debitAmount = -transaction.amount.value;
        debitTransactionsAmount.push(debitAmount); 
    }
    let creditAmount = null;
    if(transaction.dc.isCredit()){
        creditAmount = transaction.amount.value; 
        creditTransactionsAmount.push(creditAmount); 
    }
    
    // Here we have extracted the most of required values, you can
    // do the stuff with them inside the loop
}
const firstTransaction: Transaction = allTransactions[0];
const lastTransaction: Transaction  = allTransactions[allTransactions.length-1];

// Finally the values for summary 
const initialBalance = firstTransaction.wallet.before.balance.available
const endBalance = lastTransaction.wallet.after.balance.available
const totalDebits = debitTransactionsAmount.reduce((sum, el) => sum + el, 0);
const totalCredits = creditTransactionsAmount.reduce((sum, el) => sum + el, 0);

// Congratulation 🎉🥳👏
// At this point, you can create a beautiful PDF or HTML Table for your user 🥂👏🍾