This is a library willing to help you to integrate the Vodacom M-Pesa operations to your application.
Using this library, you can implement the following operations:
- Receive money from a mobile account to a business account (C2B)
- Send money from a business account to a mobile account (B2C)
- Send money from a business account to another business account (B2B)
- Revert any of the transactions above mentioned
- Query the status of a transaction
- Valid credentials obtained from the Mpesa Developer portal
- Port 18352 open on your server (usually open on local env)
-
Add jitpack to your root
build.gradlefile, underrepositories:repositories { // ... other repositories here ... maven { url 'https://jitpack.io' } } -
Add the dependency:
dependencies { implementation 'com.github.paymentsds:mpesa-java-sdk:0.1.0-alpha1' }
-
Add jitpack to your
pom.xmlfile, underrepositories:<repositories> <repository> <id>jitpack.io</id> <url>https://jitpack.io</url> </repository> </repositories>
-
Add the dependency:
<dependency> <groupId>com.github.paymentsds</groupId> <artifactId>mpesa-java-sdk</artifactId> <version>0.1.0-alpha1</version> </dependency>
git clone https://github.com/paymentsds/mpesa-sdkUsing this SDK is very simple and fast, let us see some examples:
import org.paymentsds.mpesa.Callback;
import org.paymentsds.mpesa.Client;
import org.paymentsds.mpesa.Environment;
import org.paymentsds.mpesa.Request;
import org.paymentsds.mpesa.Response;
Client client = new Client.Builder()
.apiKey("<REPLACE>")
.publicKey("<REPLACE>")
.serviceProviderCode("<REPLACE>")
.initiatorIdentifier("<REPLACE>")
.environment(Environment.DEVELOPMENT)
.build();
Request paymentRequest = new Request.Builder()
.amount(10.0)
.from("841234567")
.reference("12345")
.transaction("12345")
.build();
// Synchronous Call
try {
Response response = client.receive(paymentRequest);
// Handle success scenario
} catch (Exception e) {
// Handle failure scenario
}
// Asynchronous Call
client.receive(paymentRequest, new Callback() {
@Override
public void onResponse(Response response) {
// Handle success scenario
}
@Override
public void onError(Exception e) {
// Handle failure scenario
}
});import org.paymentsds.mpesa.Callback;
import org.paymentsds.mpesa.Client;
import org.paymentsds.mpesa.Environment;
import org.paymentsds.mpesa.Request;
import org.paymentsds.mpesa.Response;
Client client = new Client.Builder()
.apiKey("<REPLACE>")
.publicKey("<REPLACE>")
.serviceProviderCode("<REPLACE>")
.initiatorIdentifier("<REPLACE>")
.environment(Environment.PRODUCTION)
.build();
Request paymentRequest = new Request.Builder()
.amount(10.0)
.to("841234567")
.reference("12345")
.transaction("12345")
.build();
// Synchronous Call
try {
Response response = client.send(paymentRequest);
// Handle success scenario
} catch (Exception e) {
// Handle failure scenario
}
// Asynchronous Call
client.send(paymentRequest, new Callback() {
@Override
public void onResponse(Response response) {
// Handle success scenario
}
@Override
public void onError(Exception e) {
// Handle failure scenario
}
});import org.paymentsds.mpesa.Callback;
import org.paymentsds.mpesa.Client;
import org.paymentsds.mpesa.Environment;
import org.paymentsds.mpesa.Request;
import org.paymentsds.mpesa.Response;
Client client = new Client.Builder()
.apiKey("<REPLACE>")
.publicKey("<REPLACE>")
.serviceProviderCode("<REPLACE>")
.initiatorIdentifier("<REPLACE>")
.environment(Environment.PRODUCTION)
.build();
Request paymentRequest = new Request.Builder()
.amount(10.0)
.to("54321")
.reference("12345")
.transaction("12345")
.build();
// Synchronous Call
try {
Response response = client.send(paymentRequest);
// Handle success scenario
} catch (Exception e) {
// Handle failure scenario
}
// Asynchronous Call
client.send(paymentRequest, new Callback() {
@Override
public void onResponse(Response response) {
// Handle success scenario
}
@Override
public void onError(Exception e) {
// Handle failure scenario
}
});import org.paymentsds.mpesa.Callback;
import org.paymentsds.mpesa.Client;
import org.paymentsds.mpesa.Environment;
import org.paymentsds.mpesa.Request;
import org.paymentsds.mpesa.Response;
Client client = new Client.Builder()
.apiKey("<REPLACE>")
.publicKey("<REPLACE>")
.serviceProviderCode("<REPLACE>")
.initiatorIdentifier("<REPLACE>")
.environment(Environment.PRODUCTION)
.securityCredential("<REPLACE>")
.build();
Request reversalRequest = new Request.Builder()
.amount(10.0)
.reference("12345")
.transaction("12345")
.build();
// Synchronous Call
try {
Response response = client.revert(reversalRequest);
// Handle success scenario
} catch (Exception e) {
// Handle failure scenario
}
// Asynchronous Call
client.revert(reversalRequest, new Callback() {
@Override
public void onResponse(Response response) {
// Handle success scenario
}
@Override
public void onError(Exception e) {
// Handle failure scenario
}
});import org.paymentsds.mpesa.Callback;
import org.paymentsds.mpesa.Client;
import org.paymentsds.mpesa.Environment;
import org.paymentsds.mpesa.Request;
import org.paymentsds.mpesa.Response;
Client client = new Client.Builder()
.apiKey("<REPLACE>")
.publicKey("<REPLACE>")
.serviceProviderCode("<REPLACE>")
.build();
Request queryRequest = new Request.Builder()
.reference("12345") // input_ThirdPartyReference
.subject("12345") // input_QueryReference
.build();
// Synchronous Call
try {
Response response = client.query(queryRequest);
// Handle success scenario
} catch (Exception e) {
// Handle failure scenario
}
// Asynchronous Call
client.query(queryRequest, new Callback() {
@Override
public void onResponse(Response response) {
// Handle success scenario
}
@Override
public void onError(Exception e) {
// Handle failure scenario
}
});Thank you for considering contributing to this package. If you wish to do it, email us at [email protected] and we will get back to you as soon as possible.
If you discover a security vulnerability, please email us at [email protected] and we will address the issue with the needed urgency.
Copyright 2022 © The PaymentsDS Team
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http:https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.