Package io.github.openpaydev.mpesa.core

Class MpesaConfig.MpesaConfigBuilder

java.lang.Object

io.github.openpaydev.mpesa.core.MpesaConfig.MpesaConfigBuilder

Enclosing class:

MpesaConfig

public static class MpesaConfig.MpesaConfigBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
MpesaConfig	build()
MpesaConfig.MpesaConfigBuilder	businessShortCode(String businessShortCode)	The Business Short Code, which is the identifier for your PayBill or Till Number.
MpesaConfig.MpesaConfigBuilder	consumerKey(String consumerKey)	The Consumer Key obtained from the Safaricom Developer Portal.
MpesaConfig.MpesaConfigBuilder	consumerSecret(String consumerSecret)	The Consumer Secret obtained from the Safaricom Developer Portal.
MpesaConfig.MpesaConfigBuilder	environment(MpesaEnvironment environment)	The Mpesa environment to use, either MpesaEnvironment.SANDBOX or MpesaEnvironment.PRODUCTION.
MpesaConfig.MpesaConfigBuilder	passKey(String passKey)	The Lipa Na M-Pesa Pass Key, used to encrypt the password for STK Push requests.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

consumerKey

public MpesaConfig.MpesaConfigBuilder consumerKey(String consumerKey)

The Consumer Key obtained from the Safaricom Developer Portal.

Returns:

this.

consumerSecret

public MpesaConfig.MpesaConfigBuilder consumerSecret(String consumerSecret)

The Consumer Secret obtained from the Safaricom Developer Portal.

Returns:

this.

businessShortCode

public MpesaConfig.MpesaConfigBuilder businessShortCode(String businessShortCode)

The Business Short Code, which is the identifier for your PayBill or Till Number. Renamed from 'shortCode' to align with the official M-Pesa API documentation.

Returns:

this.

passKey

public MpesaConfig.MpesaConfigBuilder passKey(String passKey)

The Lipa Na M-Pesa Pass Key, used to encrypt the password for STK Push requests.

Returns:

this.

environment

public MpesaConfig.MpesaConfigBuilder environment(MpesaEnvironment environment)

The Mpesa environment to use, either MpesaEnvironment.SANDBOX or MpesaEnvironment.PRODUCTION.

Returns:

this.

build

public MpesaConfig build()

toString

public String toString()

Overrides:

toString in class Object