Logo Blue Finalse
Console 
  Français   English


C#


  • GETTING STARTED
  • Authentication
  • Hello World
  • Pricing
  • Rate Limit
  • USE CASES
  • FPay UI Integration
  • Custom UI Integration
  • Interoperability  New
  • Payment links and QRCodes
  • Third Parties Money  New
  • Audit & Dashboard  New
  • REFERENCES
  • Attempt
  • AuthAccess
  • Deposit
  • FundRequest
  • QuasiTransfer
  • Transaction
  • Transfer
  • Wallet
Logo Blue FinalseLogo Blue Finalse
Javascript
Console 
  Français   English
  • GETTING STARTED
  • Authentication
  • Hello World
  • Pricing
  • Rate Limit
  • USE CASES
  • FPay UI Integration
  • Custom UI Integration
  • Interoperability  New
  • Payment links and QRCodes
  • Third Parties Money  New
  • Audit & Dashboard  New
  • REFERENCES
  • Attempt
  • AuthAccess
  • Deposit
  • FundRequest
  • QuasiTransfer
  • Transaction
  • Transfer
  • Wallet

Deposit

Introducing  

This object is used to deposit money from a mobile money account to an FPay wallet. When initiated, a Deposit immediately triggers a request to a mobile money account to retrieve the specified amount.
Because the owner of the mobile money account must absolutely validate the cash outflow, there exists an attempt.id field which represents the identifier of theMulti Factor Authentication Attempt. With this identifier, you can retrieve an Attempt object, which will tell you which instructions the customer must execute to authenticate the deposit, as well as the time remaining before it expires.

Any instance of this object passes through several states, which can be tracked by observing the status field: At the beginning it will be Starting, and at the end, the state will be either Successful or Failure.
Once the deposit is complete, a Transaction object will be created to materialize the entry of money into the FPay wallet. The title of this Transaction object can be controlled from the Deposit object by specifying the h1. field. If you omit this field, a default title will be added when the Transaction object is created, visible by accessing the h1 field of the Transaction object.

Operations  

get  

Returns an object Deposit found by an identifier.
You can use a unique ID specific to your system. To use your own ID instead of the one generated by FPay, you need to specify the foreignId field when creating the object. This will enable you to retrieve the object via the foreignId field, which must be unique for all Deposit objects.  Here are all the fields whose values can be used as identifiers for this operation:

  • id
  • foreignId
  • attempt.id

const depositPromise = fPay.deposit.get("identifier");


initiate  

Initiate a new Deposit operation and return the newly created instance.
This operation takes the following parameters as input:

InitiateDepositForm
amount
Required
AmountForm
Transaction amount without fees. If you pay the fees, you will receive in your wallet this amount minus fees. If your correspondent pays the fees, you will receive exactly this amount in your wallet.
currency
Required
string
The only possible value is"XOF"  
value
Required
string
Numeric value of amount always positive or zero.
source
Required
SourceForm
Source of funds.
SourceForm.MultipleSourceForm
MultipleSourceForm

SourceForm.SingleSourceForm
SingleSourceForm
account
Required
MoneyAccountForm
Mobile money account from which you would like to collect money.
country
Required
string
The only possible value is"CI"  
identifier
Required
string
Telephone number in international  "+2250500000000"
providerKey
Required
string
The only possible values are"MoovMoney"  "MtnMoney"  "OrangeMoney"  

description
string | undefined
Details, explanations and notes about this item to help you get organized and find your way around later.
destination
DestinationForm | undefined
Destination of funds.
DestinationForm.MultipleDestinationForm
MultipleDestinationForm

DestinationForm.SingleDestinationForm
SingleDestinationForm
account
Required
MoneyAccountForm
FPay Wallet   which will be credited when the money is received. This value is optional and if no value is specified, the main wallet will be credited.
country
Required
string
The only possible value is"CI"  
identifier
Required
string
FPay Wallet id identifier
providerKey
Required
string
The only possible value is"FPay"  

fees
FeesForm | undefined
payer
Required
string
Who pays the fees associated with this operation ?  If no costs are involved, this value will be omitted.
The only possible values are"CounterPart"  "Me"  "Receiver"  "Sender"  
foreignData
string | undefined
Your own data that you can attach to the object you've created. This can be JSON XML other data formats or simply Strings.
The maximum allowed length is 128 characters.
foreignId
string | undefined
ID Personalisé ou bien ID de votre système interne que vous souhaitez attacher à cet objet pour vous permettre de le récupérer plus tard.
Once created, this value cannot be modified.
This value must be unique for each type.
The maximum allowed length is 128 characters.
h1
H1DescriptorForm | undefined
Title of this object, which will be displayed to the user if necessary, and which will become the h1 field of the Transaction object when it will be created.
en
string | undefined
fr
string | undefined

Here's an example of code for initiate a Deposit object:

const depositPromise = 
    fPay.deposit.initiate({
        amount: {
            currency: "XOF",
            value: "10_000"
        },
        source: {
            _type: "Single",
            account: {
                country: "CI",
                identifier: "+2250500000000",
                providerKey: "MtnMoney"
            }
        },
        description: "My description",
        destination: {
            _type: "Single",
            account: {
                country: "CI",
                identifier: "123456789",
                providerKey: "FPay"
            }
        },
        fees: {
            payer: "CounterPart"
        },
        foreignData: "{\"myKey\": 19, \"myOtherKey\": \"myOtherValue\"}",
        foreignId: "123456789",
        h1: {
            en: "Payment description",
            fr: "Description du paiement"
        }
    });


list  

Returns a collection of Deposit objects, possibly filtered and/or sorted. Here are the parameters supported by this operation.

NAMETYPEDESCRIPTIONDEFAULT VALUE
filterstring | undefinedCondition to be met by any object returned in this collection
undefined
sortBystring | undefinedSpecify the field and the order (ascending or descending) by which returned objects will be sorted
createdTime:DESC
limitnumber | undefinedTotal number of results to return in this collection
50

Here are a few examples of code to execute a listing to return a collection of Deposit objects:

const depositsCollectionPromise = fPay.deposit.listAll();
const depositsCollectionPromise = 
    fPay.deposit.list({
        sortBy: "id:ASC"
    });
const depositsCollectionPromise = 
    fPay.deposit.list({
        limit: 5
    });
const depositsCollectionPromise = 
    fPay.deposit.list({
        filter: "id in {'31234', '5678', '9990'}"
    });
const depositsCollectionPromise = 
    fPay.deposit.list({
        filter: "createdTime isBefore Yesterday",
        sortBy: "foreignId:DESC"
    });
const depositsCollectionPromise = 
    fPay.deposit.list({
        filter: "id startsWith abcd",
        sortBy: "createdTime:ASC",
        limit: 25
    });


fetchPage  

When you fetch a list of Deposit, the results returned by the server can be paginated, i.e. they will be arranged on several pages. This fetchPage function allows you to navigate from page to page, iterating over all the elements. Consequently, this function returns a collection of Deposit.

Let's say you've retrieved a collection of Deposit with the following code:

const depositsCollectionPromise = fPay.deposit.listAll();

If the result is spread over several pages, to go to the next page, you should do:

depositsCollectionPromise.then(depositCollection => {
    if(depositCollection.hasNextPage()) {
        const nextDepositPromise = fPay.deposit.fetchPage(depositCollection.pagination.nextPage);
    }
});


update  

Modify a Deposit object and return the modified version.
 Here are all the fields whose values can be used as identifiers for this operation:

  • id
  • foreignId
  • attempt.id
Modifying an object means modifying its modifiable fields. Modifiable fields can be either updated or deleted. Here's the list of modifiable fields for all Deposit objects:

NAMETYPEDESCRIPTION
descriptionstring | undefinedCan be updated   Can be Deleted
foreignDatastring | undefinedCan be updated   Can be Deleted

Here are a few examples of code to execute an update:

depositPromise = 
    fPay.deposit.update({
         id: "<id | foreignId>",
         change: {
            description: "<new value>",
            foreignData: "<new value>"
         }
    });
depositPromise = 
    fPay.deposit.update({
         id: "<id | foreignId>",
         change: {
            description: "<new value>"
         },
         'remove': ['foreignData']
    });
depositPromise = 
    fPay.deposit.update({
         id: "<id | foreignId>",
         'remove': ['description', 'foreignData']
    });

List Filter & Sort  

Fields  

When you retrieve a list, here are the fields you can use for filtering and sorting. as well as sorting.

NAMETYPEDESCRIPTION
amount.currency.codestring
amount.valuenumber
attempt.idstring
completedTimestring
completedTime.iso8601string
completedTime.timestamp.millisecondsnumber
completedTime.timestamp.secondsnumber
createdTimestring
createdTime.iso8601string
createdTime.timestamp.millisecondsnumber
createdTime.timestamp.secondsnumber
creatorstring
creator._typestring
creator.accountIdstring
creator.authAccessIdstring
creator.personIdstring
descriptionstring
destinationstring
destination._typestring
destination.account.balanceTypestring
destination.account.identifier._typestring
destination.account.identifier.valuestring
destination.account.provider.country.iso3166.alpha2string
destination.account.provider.country.iso3166.alpha3string
destination.account.provider.country.namestring
destination.account.provider.keystring
destination.account.provider.namestring
destination.amount.currency.codestring
destination.amount.valuenumber
fees.amount.currency.codestring
fees.amount.valuenumber
fees.payerstring
fees.value.fixenumber
fees.value.percentnumber
foreignIdstring
h1Descriptor.enstring
h1Descriptor.frstring
idstring
sendingstring
sourcestring
source._typestring
source.account.balanceTypestring
source.account.identifier._typestring
source.account.identifier.valuestring
source.account.provider.country.iso3166.alpha2string
source.account.provider.country.iso3166.alpha3string
source.account.provider.country.namestring
source.account.provider.keystring
source.account.provider.namestring
source.amount.currency.codestring
source.amount.valuenumber
statusstring

Code examples  

Code examples are available on the Audit & Dashboard page

Fields  

Deposit
amount
Amount
currency
AmountCurrency
code
string
The only possible value is"XOF"  
unit
string
Symbol used to represent this currency. For now, the only value is "₣".
value
number
Numeric value of amount always positive or zero.
attempt
LightAttempt
id
string
Unique, unchangeable identifier made up of numbers and letters.
completedTime
UTCDateTime | undefined
If this value is present, then it corresponds to the date and time at which this operation ended. If it is absent, then this operation is still in progress.
Value always stored in UTC (Universal Time), this field contains a representation of this instant in ISO 8601 format, as well as a representation of this same instant in timestamp seconds and milliseconds.
iso8601
string
Date and time in ISO 8601 format
timestamp
Timestamp
milliseconds
number
Date and time in timestamp milli seconds
seconds
Double
Date and time in timestamp seconds
createdTime
UTCDateTime
Date and time at which this object was created. Value always stored in UTC (Universal Time), this field contains a representation of this instant in ISO 8601 format, as well as a representation of this same instant in timestamp seconds and milliseconds.
iso8601
string
Date and time in ISO 8601 format
timestamp
Timestamp
milliseconds
number
Date and time in timestamp milli seconds
seconds
Double
Date and time in timestamp seconds
creator
Creator
Creator.Api
Api
_type
string
The only possible value is"Api"  
accountId
string
authAccessId
string

Creator.Ui
Ui
_type
string
The only possible value is"Ui"  
accountId
string
personId
string

description
string | undefined
Details, explanations and notes about this item to help you get organized and find your way around later.
destination
Destination
Destination.Multiple
Multiple
_type
string
The only possible value is"Multiple"  

Destination.Single
Single
_type
string
The only possible value is"Single"  
account
MoneyAccount
balanceType
string
Indicates the type of balance used.
"AvailableBalance" literally means “Available Balance”. So, if the value of this field is “AvailableBalance”, then the funds are on the "AvailableBalance" and can be used. In some cases, funds are “Locked” (either on the "LockedInBalance" or   "LockedOutBalance" ) and cannot be used until they are made available on the "AvailableBalance".
The only possible values are"AvailableBalance"  "LockedInBalance"  "LockedOutBalance"  
identifier
MoneyAccountIdentifier
_type
string
Indicates the type of account on which “MoneyAccount” money is held. If it's a bank account, this field will have the value "Iban".
If it's a mobile money account, this field will have the value "MobileMoney".
If it's an FPay wallet, the value can be either "Id" or "Man", the latter meaning "Money Account Number".
The only possible values are"Iban"  "Id"  "Man"  "MobileNumber"  
value
string
Indicates the type of account on which “MoneyAccount” money is held. If it's a bank account, this field will have the value "Iban".
If it's a mobile money account, this field will have the value "MobileMoney".
If it's an FPay account, the value can be either "Id" or "Man", the latter meaning "Money Account Number".
provider
MoneyAccountProvider
country
Country
iso3166
Iso3166Country
alpha2
string
ISO 3166 code with 2 characters representing the country.
Example: “CI” for Côte d'Ivoire, “BF” for Burkina Faso and “SN” for Senegal.
alpha3
string
ISO 3166 code with 3 characters representing the country.
Example: “CIV” for Côte d'Ivoire, “BFA” for Burkina Faso and “SEN” for Senegal.
name
string
Country name in either English or French, depending on the language of your FPay account. If, when you registered, you chose French as the language of your account, then the country name will be in French. in French and if you have chosen English, then this name will be in English.
key
string
Key uniquely identifying the money account provider.
The only possible values are"FPay"  "MoovMoney"  "MtnMoney"  "OrangeMoney"  
name
string
Money account provider name
amount
Amount
currency
AmountCurrency
code
string
The only possible value is"XOF"  
unit
string
Symbol used to represent this currency. For now, the only value is "₣".
value
number
Numeric value of amount always positive or zero.

fees
Fees
amount
Amount
currency
AmountCurrency
code
string
The only possible value is"XOF"  
unit
string
Symbol used to represent this currency. For now, the only value is "₣".
value
number
Numeric value of amount always positive or zero.
payer
string | undefined
Who pays the fees associated with this operation ?  If no costs are involved, this value will be omitted.
The only possible values are"Receiver"  "Sender"  
value
FeesValue
fixe
number
Fixed part of the fee amount. If the formula for calculating the fee is 1.5% + ₣150, then this field will have the value 150
percent
number
Variable part of the fee amount between 0 and  100. If the formula for calculating the fee is 1,5% + ₣150,  then this field will have a value of 1,5.
foreignData
string | undefined
Your own data that you can attach to the object you've created. This can be JSON XML other data formats or simply Strings.
The maximum allowed length is 128 characters.
foreignId
string | undefined
ID Personalisé ou bien ID de votre système interne que vous souhaitez attacher à cet objet pour vous permettre de le récupérer plus tard.
Once created, this value cannot be modified.
This value must be unique for each type.
The maximum allowed length is 128 characters.
h1Descriptor
H1Descriptor | undefined
en
string | undefined
fr
string | undefined
id
string
Unique, unchangeable identifier made up of numbers and letters.
sending
string
The only possible values are"NotYetDone"  "PartiallyDone"  "TotallyDone"  
source
Source
Source.Multiple
Multiple
_type
string
The only possible value is"Multiple"  

Source.Single
Single
_type
string
The only possible value is"Single"  
account
MoneyAccount
balanceType
string
Indicates the type of balance used.
"AvailableBalance" literally means “Available Balance”. So, if the value of this field is “AvailableBalance”, then the funds are on the "AvailableBalance" and can be used. In some cases, funds are “Locked” (either on the "LockedInBalance" or   "LockedOutBalance" ) and cannot be used until they are made available on the "AvailableBalance".
The only possible values are"AvailableBalance"  "LockedInBalance"  "LockedOutBalance"  
identifier
MoneyAccountIdentifier
_type
string
Indicates the type of account on which “MoneyAccount” money is held. If it's a bank account, this field will have the value "Iban".
If it's a mobile money account, this field will have the value "MobileMoney".
If it's an FPay wallet, the value can be either "Id" or "Man", the latter meaning "Money Account Number".
The only possible values are"Iban"  "Id"  "Man"  "MobileNumber"  
value
string
Indicates the type of account on which “MoneyAccount” money is held. If it's a bank account, this field will have the value "Iban".
If it's a mobile money account, this field will have the value "MobileMoney".
If it's an FPay account, the value can be either "Id" or "Man", the latter meaning "Money Account Number".
provider
MoneyAccountProvider
country
Country
iso3166
Iso3166Country
alpha2
string
ISO 3166 code with 2 characters representing the country.
Example: “CI” for Côte d'Ivoire, “BF” for Burkina Faso and “SN” for Senegal.
alpha3
string
ISO 3166 code with 3 characters representing the country.
Example: “CIV” for Côte d'Ivoire, “BFA” for Burkina Faso and “SEN” for Senegal.
name
string
Country name in either English or French, depending on the language of your FPay account. If, when you registered, you chose French as the language of your account, then the country name will be in French. in French and if you have chosen English, then this name will be in English.
key
string
Key uniquely identifying the money account provider.
The only possible values are"FPay"  "MoovMoney"  "MtnMoney"  "OrangeMoney"  
name
string
Money account provider name
amount
Amount
currency
AmountCurrency
code
string
The only possible value is"XOF"  
unit
string
Symbol used to represent this currency. For now, the only value is "₣".
value
number
Numeric value of amount always positive or zero.

status
DepositStatus
DepositStatus.Completing
Completing
_type
string
The only possible value is"Completing"  

DepositStatus.Failure
Failure
_type
string
The only possible value is"Failure"  
cancelled
Cancelled | undefined
afterTimeout
boolean
reason
LocalizedText
en
string
fr
string

DepositStatus.Processing
Processing
_type
string
The only possible value is"Processing"  
reason
LocalizedText
en
string
fr
string

DepositStatus.Started
Started
_type
string
The only possible value is"Started"  

DepositStatus.Starting
Starting
_type
string
The only possible value is"Starting"  

DepositStatus.Successful
Successful
_type
string
The only possible value is"Successful"  

DepositStatus.WaitingToStart
WaitingToStart
_type
string
The only possible value is"WaitingToStart"  

url
string
URL on which a properly authorized GET method will return the instance of the object on which this field is defined.

DEPOSIT
  • Introducing
  • Oprations
    • Get
    • Initiate
    • List
    • FetchPage
    • Update
  • List Filter & Sort
    • Fields
    • Code example
  • Object Fields