Payment Gateway for the Mifos Platform and Beyonic Payment Service
Implement the Mifos payment gateway service to support the following use cases:
Real time disbursement
Batch disbursement
Customer initiated payments
Develop a Payment Gateway portal for the payment gateway.
Develop a particular mobile money integration on the payment gateway to show it works.
Document the api for the payment gateway.
Implemented a payment gateway which supports the following use cases:
Real time disbursement
Batch disbursement
Customer initiated payments
Developed a mobile money integration with Beyonic to test the payment gateway.
Implementing the payment gateway portal which will be used by MFIs and MMPs.
Documentating the payment gateway's api to facilitate integration with other MMP apis.
Implementing test on the payment gateway and Beyonic Payment service.
Setup information for both the Payment gateway and Beyonic's payment service
Download MySql 5.6 and above.
Download Java(JDK) 1.8 and above.
Download an IDE that support gradle, most preferably Intellij and turn on annotation processing in your settings.
Clone the code from the above repository
Upload the project into your favorite IDE as a Gradle project.
Run gradle build and then run the application.
Open your mysql and create a database called mifos-payment-gateway
Go to application.properties file in the resource folder of our application.
- Change the spring.datasource.username to your database username and the spring.datasource.password to your database password.
API documentation for Payment Gateway
Customer Initiated payment (Loan Repayment)
Example Request:
POST http://localhost:8080/inbound/requests? tenant=default
Content-Type: application/json
Request Body:
{
" id" : 1,
" transactType" : " LOAN_REPAYMENT" " paymentMethod" : " mobile money" " paymentMethodType" : " beyonic" " mmpId" : 1,
" mfiId" : 1,
" sourceRef" : " +233267881050" " destinationRef" : " +80000000001" " fineractAccNo" : " 000000039" " fineractClientId" : 1,
" amount" : 10,
" transactionReason" : " Test Beyonic" " externalSystId" : 0,
" comments" : " outgoing payment" " requestDtm" : " 1503492596" " requestIpAddress" : " 127.0.0.1" " inboundStatusId" : 0,
" inboundStatusDtm" : " 1503492596" " id" " code" " 2100" " description" " Request was received" " statusCategory"
Customer Initiated payment (Voluntary Customer Saving)
Example Request:
POST http://localhost:8080/inbound/requests? tenant=default
Content-Type: application/json
Request Body:
{
" id" : 1,
" transactType" : " VOLUNTARY_SAVINGS" " paymentMethod" : " mobile money" " paymentMethodType" : " beyonic" " mmpId" : 1,
" mfiId" : 1,
" sourceRef" : " +233267881050" " destinationRef" : " +80000000001" " fineractAccNo" : " 000000001" " fineractClientId" : 1,
" amount" : 10,
" transactionReason" : " Test Beyonic" " externalSystId" : 0,
" comments" : " outgoing payment" " requestDtm" : " 1503492596" " requestIpAddress" : " 127.0.0.1" " inboundStatusId" : 0,
" inboundStatusDtm" : " 1503492596" " id" " code" " 2100" " description" " Request was received" " statusCategory"
Customer Initiated payment (Recurring Customer deposit)
Example Request:
POST http://localhost:8080/inbound/requests? tenant=default
Content-Type: application/json
Request Body:
{
" id" : 1,
" transactType" : " RECURRING_DEPOSIT" " paymentMethod" : " mobile money" " paymentMethodType" : " beyonic" " mmpId" : 1,
" mfiId" : 1,
" sourceRef" : " +233267881050" " destinationRef" : " +80000000001" " fineractAccNo" : " abc000000047" " fineractClientId" : 1,
" amount" : 10,
" transactionReason" : " Test Beyonic" " externalSystId" : 0,
" comments" : " outgoing payment" " requestDtm" : " 1503492596" " requestIpAddress" : " 127.0.0.1" " inboundStatusId" : 0,
" inboundStatusDtm" : " 1503492596" " id" " code" " 2100" " description" " Request was received" " statusCategory"
Real time loan disbursement
Example Request:
POST http://localhost:8080/outbound/requests? tenant=default
Content-Type: application/json
Request Body:
{
" id" : 1,
" transactType" : " DISBURSEMENT" " paymentMethod" : " mobile money" " paymentMethodType" : " beyonic" " mmpId" : 1,
" mfiId" : 1,
" sourceRef" : " +233267881050" " destinationRef" : " +80000000001" " fineractAccNo" : " abc000000047" " fineractClientId" : 1,
" amount" : 10,
" transactionReason" : " Test Beyonic" " externalSystId" : 0,
" comments" : " outgoing payment" " requestDtm" : " 1503492596" " requestIpAddress" : " 127.0.0.1" " outboundStatusId" : 0,
" outboundStatusDtm" : " 1503492596" " reverseStatusId" : 0,
" reverseStatusIdDtm" : " 1503492596" " id" " code" " 2100" " description" " Request was received" " statusCategory"
Get recurring deposit account
Example Request:
POST http://localhost:8080/recurringDepositAccounts? tenant=default
Content-Type: application/json
Request Body:
{
" accountNumber" " 000000017" " id" " accountNo" " RD000023" " externalId" " RD-23" " clientId" " clientName" " Sangamesh N" " savingsProductId" " savingsProductName" " RD01" " fieldOfficerId" " status" " id" " code" " savingsAccountStatusType.submitted.and.pending.approval" " value" " Submitted and pending approval" " submittedAndPendingApproval" " approved" " rejected" " withdrawnByApplicant" " active" " closed" " prematureClosed" " transferInProgress" " transferOnHold" false
},
" timeline" " submittedOnDate" " submittedByUsername" " mifos" " submittedByFirstname" " App" " submittedByLastname" " Administrator" " currency" " code" " USD" " name" " US Dollar" " decimalPlaces" " inMultiplesOf" " displaySymbol" " $" " nameCode" " currency.USD" " displayLabel" " US Dollar ($)" " interestCompoundingPeriodType" " id" " code" " savings.interest.period.savingsCompoundingInterestPeriodType.monthly" " value" " Monthly" " interestPostingPeriodType" " id" " code" " savings.interest.posting.period.savingsPostingInterestPeriodType.monthly" " value" " Monthly" " interestCalculationType" " id" " code" " savingsInterestCalculationType.dailybalance" " value" " Daily Balance" " interestCalculationDaysInYearType" " id" " code" " savingsInterestCalculationDaysInYearType.days365" " value" " 365 Days" " preClosurePenalApplicable" " minDepositTerm" " maxDepositTerm" " minDepositTermType" " id" " code" " deposit.term.savingsPeriodFrequencyType.months" " value" " Months" " maxDepositTermType" " id" " code" " deposit.term.savingsPeriodFrequencyType.years" " value" " Years" " recurringDepositAmount" " recurringDepositFrequency" " expectedFirstDepositOnDate" " recurringDepositFrequencyType" " id" " code" " recurring.deposit.savingsPeriodFrequencyType.months" " value" " Months" " depositPeriod" " depositPeriodFrequency" " id" " code" " deposit.period.savingsPeriodFrequencyType.months" " value" " Months" " summary" " currency" " code" " USD" " name" " US Dollar" " decimalPlaces" " inMultiplesOf" " displaySymbol" " $" " nameCode" " currency.USD" " displayLabel" " US Dollar ($)" " accountBalance" " accountChart" " id" " fromDate" " accountId" " accountNumber" " RD000023" " chartSlabs" " id" " periodType" " id" " code" " interestChartPeriodType.days" " value" " Days" " fromPeriod" " toPeriod" " annualInterestRate" " currency" " code" " USD" " name" " US Dollar" " decimalPlaces" " displaySymbol" " $" " nameCode" " currency.USD" " displayLabel" " US Dollar ($)" " id" " periodType" " id" " code" " interestChartPeriodType.days" " value" " Days" " fromPeriod" " toPeriod" " annualInterestRate" " currency" " code" " USD" " name" " US Dollar" " decimalPlaces" " displaySymbol" " $" " nameCode" " currency.USD" " displayLabel" " US Dollar ($)" " id" " periodType" " id" " code" " interestChartPeriodType.days" " value" " Days" " fromPeriod" " annualInterestRate" " currency" " code" " USD" " name" " US Dollar" " decimalPlaces" " displaySymbol" " $" " nameCode" " currency.USD" " displayLabel" " US Dollar ($)" " periodTypes" " id" " code" " interestChartPeriodType.days" " value" " Days" " id" " code" " interestChartPeriodType.weeks" " value" " Weeks" " id" " code" " interestChartPeriodType.months" " value" " Months" " id" " code" " interestChartPeriodType.years" " value" " Years"
Get customer loan account
Example Request:
POST http://localhost:8080//loans? tenant=default
Content-Type: application/json
Request Body:
{
" accountNumber" " 000000017" " id" " accountNo" " 000000001" " status" " id" " code" " loanStatusType.active" " value" " Active" " pendingApproval" " waitingForDisbursal" " active" " closedObligationsMet" " closedWrittenOff" " closedRescheduled" " closed" " overpaid" false
},
" clientId" " clientName" " Kampala first Client" " clientOfficeId" " loanProductId" " loanProductName" " Kampala Product (with cash accounting)" " loanProductDescription" " Typical Kampala loan product with cash accounting enabled for testing." " loanPurposeId" " loanPurposeName" " option.HousingImprovement" " loanOfficerId" " loanOfficerName" " LoanOfficer, Kampala" " loanType" " id" " code" " loanType.individual" " value" " Individual" " currency" " code" " UGX" " name" " Uganda Shilling" " decimalPlaces" " displaySymbol" " USh" " nameCode" " currency.UGX" " displayLabel" " Uganda Shilling (USh)" " principal" " termFrequency" " termPeriodFrequencyType" " id" " code" " termFrequency.periodFrequencyType.months" " value" " Months" " numberOfRepayments" " repaymentEvery" " repaymentFrequencyType" " id" " code" " repaymentFrequency.periodFrequencyType.months" " value" " Months" " interestRatePerPeriod" " interestRateFrequencyType" " id" " code" " interestRateFrequency.periodFrequencyType.years" " value" " Per year" " annualInterestRate" " amortizationType" " id" " code" " amortizationType.equal.installments" " value" " Equal installments" " interestType" " id" " code" " interestType.flat" " value" " Flat" " interestCalculationPeriodType" " id" " code" " interestCalculationPeriodType.same.as.repayment.period" " value" " Same as repayment period" " transactionProcessingStrategyId" " timeline" " submittedOnDate" " submittedByUsername" " admin" " submittedByFirstname" " App" " submittedByLastname" " Administrator" " approvedOnDate" " approvedByUsername" " admin" " approvedByFirstname" " App" " approvedByLastname" " Administrator" " expectedDisbursementDate" " actualDisbursementDate" " disbursedByUsername" " admin" " disbursedByFirstname" " App" " disbursedByLastname" " Administrator" " expectedMaturityDate" " summary" " currency" " code" " UGX" " name" " Uganda Shilling" " decimalPlaces" " displaySymbol" " USh" " nameCode" " currency.UGX" " displayLabel" " Uganda Shilling (USh)" " principalDisbursed" " principalPaid" " principalWrittenOff" " principalOutstanding" " principalOverdue" " interestCharged" " interestPaid" " interestWaived" " interestWrittenOff" " interestOutstanding" " interestOverdue" " feeChargesCharged" " feeChargesDueAtDisbursementCharged" " feeChargesPaid" " feeChargesWaived" " feeChargesWrittenOff" " feeChargesOutstanding" " feeChargesOverdue" " penaltyChargesCharged" " penaltyChargesPaid" " penaltyChargesWaived" " penaltyChargesWrittenOff" " penaltyChargesOutstanding" " penaltyChargesOverdue" " totalExpectedRepayment" " totalRepayment" " totalExpectedCostOfLoan" " totalCostOfLoan" " totalWaived" " totalWrittenOff" " totalOutstanding" " totalOverdue" " overdueSinceDate" " linkedAccount" " id" " accountNo" " 000000001" " disbursementDetails" " id" " expectedDisbursementDate" " principal" " approvedPrincipal" " fixedEmiAmount" " maxOutstandingLoanBalance" " canDisburse" " emiAmountVariations" " inArrears" " isNPA" " overdueCharges" " id" " name" " overdraft penality" " active" " penalty" " currency" " code" " USD" " name" " US Dollar" " decimalPlaces" " displaySymbol" " $" " nameCode" " currency.USD" " displayLabel" " US Dollar ($)" " amount" " chargeTimeType" " id" " code" " chargeTimeType.overdueInstallment" " value" " overdue fees" " chargeAppliesTo" " id" " code" " chargeAppliesTo.loan" " value" " Loan" " chargeCalculationType" " id" " code" " chargeCalculationType.percent.of.amount" " value" " % Amount" " chargePaymentMode" " id" " code" " chargepaymentmode.regular" " value" " Regular" " feeInterval" " feeFrequency" " id" " code" " feeFrequencyperiodFrequencyType.weeks" " value" " Weeks"
Get voluntary saving account
Example Request:
POST http://localhost:8080//voluntarySavingAccounts? tenant=default
Content-Type: application/json
Request Body:
{
" accountNumber" " 000000017" " id" " accountNo" " 000000001" " clientId" " clientName" " small business" " savingsProductId" " savingsProductName" " Passbook Savings" " fieldOfficerId" " status" " id" " code" " savingsAccountStatusType.submitted.and.pending.approval" " value" " Submitted and pending approval" " submittedAndPendingApproval" " approved" " rejected" " withdrawnByApplicant" " active" " closed" false
},
" timeline" " submittedOnDate" " currency" " code" " USD" " name" " US Dollar" " decimalPlaces" " displaySymbol" " $" " nameCode" " currency.USD" " displayLabel" " US Dollar ($)" " nominalAnnualInterestRate" " interestCompoundingPeriodType" " id" " code" " savings.interest.period.savingsCompoundingInterestPeriodType.daily" " value" " Daily" " interestPostingPeriodType" " id" " code" " savings.interest.posting.period.savingsPostingInterestPeriodType.monthly" " value" " Monthly" " interestCalculationType" " id" " code" " savingsInterestCalculationType.dailybalance" " value" " Daily Balance" " interestCalculationDaysInYearType" " id" " code" " savingsInterestCalculationDaysInYearType.days365" " value" " 365 Days" " summary" " currency" " code" " USD" " name" " US Dollar" " decimalPlaces" " displaySymbol" " $" " nameCode" " currency.USD" " displayLabel" " US Dollar ($)" " accountBalance" " availableBalance" API documentation for Beyonic Payment Service
Outgoing Payment to Beyonic
```sh
Example Request:
POST http://localhost:8040/outbound/payments
Content-Type: application/json
Request Body:
{
"id" : 1,
"transactType" : "DISBURSEMENT",
"paymentMethod" : "mobile money",
"paymentMethodType" : "beyonic",
"mmpId" : 1,
"mfiId" : 1,
"sourceRef" : "+233267881050",
"destinationRef" : "+80000000001",
"fineractAccNo" : "accno123",
"fineractClientId" : 1,
"amount" : 10,
"transactionReason" : "Test Beyonic",
"externalSystId" : 0,
"comments" : "outgoing payment",
"requestDtm" : "1503492596",
"requestIpAddress" : "127.0.0.1",
"outboundStatusId" : 1,
"outboundStatusDtm" : "1503492596",
"reverseStatusId" : 1,
"reverseStatusIdDtm" : "1503492596"
}
Example Response:
{
"id": null,
"code": "2100",
"description": "Request was received",
"statusCategory": 1
}
* Beyonic Incoming payment from a client.
```sh
Example Request:
POST http://localhost:8040/collections
Content-Type: application/json
Request Body:
{
"hook": {
"id": 53,
"created": "2015-08-01T16:56:29Z",
"updated": "2015-08-01T16:56:29Z",
"event": "collection.received",
"target": "https://localhost:8040/collections",
"user": 42
},
"data": {
"id": 82,
"remote_transaction_id": "1485758785",
"organization": 1,
"amount": "2000.0000",
"currency": 2,
"phonenumber": "+80000000001",
"payment_date": "2015-07-14T09:57:44Z",
"reference": "default123456789",
"status": "successful",
"created": "2015-07-14T15:19:05Z",
"author": null,
"modified": "2015-08-20T16:48:51Z",
"updated_by": null
}
}
Example Response:
{
"id": null,
"code": "2100",
"description": "Request was received",
"statusCategory": 1
}
