mpesa

package module

Go to main page

Versions in this module

v1

v1.0.8

Feb 1, 2024

Changes in this version

+ const CustomerBuyGoodsOnlineTransactionType

+ const CustomerPayBillOnlineTransactionType

+ type AccountBalanceRequest struct

+ CommandID CommandID

+ IdentifierType IdentifierType

+ Initiator string

+ PartyA int

+ QueueTimeOutURL string

+ Remarks string

+ ResultURL string

+ SecurityCredential string

+ type BusinessPayBillRequest struct

+ AccountReference string

+ Amount uint

+ CommandID CommandID

+ Initiator string

+ Occasion string

+ PartyA uint

+ PartyB uint

+ QueueTimeOutURL string

+ RecieverIdentifierType IdentifierType

+ Remarks string

+ Requester int64

+ ResultURL string

+ SecurityCredential string

+ SenderIdentifierType IdentifierType

+ type Callback struct

+ Result CallbackResult

+ func UnmarshalCallback(r io.Reader) (*Callback, error)

+ type CallbackResult struct

+ ConversationID string

+ OriginatorConversationID string

+ ReferenceData ReferenceData

+ ResultCode int

+ ResultDesc string

+ ResultParameters ResultParameters

+ ResultType int

+ TransactionID string

+ type CommandID string

+ const AccountBalanceCommandID

+ const BusinessPayBillCommandID

+ const BusinessPaymentCommandID

+ const PromotionPaymentCommandID

+ const SalaryPaymentCommandID

+ const TransactionStatusQueryCommandID

+ type DynamicQRRequest struct

+ Amount uint

+ CreditPartyIdentifier string

+ MerchantName string

+ ReferenceNo string

+ Size string

+ TransactionType DynamicQRTransactionType

+ type DynamicQRResponse struct

+ ErrorCode string

+ ErrorMessage string

+ ImagePath string

+ QRCode string

+ RequestID string

+ ResponseCode string

+ ResponseDescription string

+ type DynamicQRTransactionType string

+ const PayMerchantBuyGoods

+ const PaybillOrBusinessNumber

+ const SendMoneyViaMobileNumber

+ const SentToBusiness

+ const WithdrawCashAtAgentTill

type Environment

+ const EnvironmentProduction

+ const EnvironmentSandbox

+ func (e Environment) BaseURL() string

+ type IdentifierType uint8

+ const ShortcodeIdentifierType

type Mpesa

+ func (m *Mpesa) BusinessPayBill(ctx context.Context, initiatorPwd string, req BusinessPayBillRequest) (*Response, error)

+ func (m *Mpesa) DynamicQR(ctx context.Context, req DynamicQRRequest, ...) (*DynamicQRResponse, error)

+ func (m *Mpesa) GetAccountBalance(ctx context.Context, initiatorPwd string, req AccountBalanceRequest) (*Response, error)

+ func (m *Mpesa) GetTransactionStatus(ctx context.Context, initiatorPwd string, req TransactionStatusRequest) (*Response, error)

+ func (m *Mpesa) RegisterC2BURL(ctx context.Context, req RegisterC2BURLRequest) (*Response, error)

+ type ReferenceData struct

+ ReferenceItem ReferenceItem

+ type ReferenceItem struct

+ Key string

+ Value string

+ type RegisterC2BURLRequest struct

+ ConfirmationURL string

+ ResponseType ResponseType

+ ShortCode uint

+ ValidationURL string

+ type Response struct

+ CheckoutRequestID string

+ ConversationID string

+ CustomerMessage string

+ ErrorCode string

+ ErrorMessage string

+ MerchantRequestID string

+ OriginatorConversationID string

+ RequestID string

+ ResponseCode string

+ ResponseDescription string

+ ResultCode string

+ ResultDesc string

+ type ResponseType string

+ const ResponseTypeCanceled

+ const ResponseTypeComplete

+ type ResultParameters struct

+ ResultParameter []ResultParameter

+ type TransactionStatusRequest struct

+ CommandID CommandID

+ IdentifierType IdentifierType

+ Initiator string

+ Occasion string

+ OriginatorConversationID string

+ PartyA uint

+ QueueTimeOutURL string

+ Remarks string

+ ResultURL string

+ SecurityCredential string

+ TransactionID string

+ type TransactionType string

v1.0.7

Dec 13, 2022

Changes in this version

+ type GeneralRequestResponse struct

+ CheckoutRequestID string

+ ConversationID string

+ CustomerMessage string

+ ErrorCode string

+ ErrorMessage string

+ MerchantRequestID string

+ OriginatorConversationID string

+ RequestID string

+ ResponseCode string

+ ResponseDescription string

+ ResultCode string

+ ResultDesc string

type Mpesa

+ func (m *Mpesa) STKQuery(ctx context.Context, passkey string, req STKQueryRequest) (*GeneralRequestResponse, error)

+ type STKQueryRequest struct

+ BusinessShortCode uint

+ CheckoutRequestID string

+ Password string

+ Timestamp string

v1.0.6

Aug 8, 2022

Changes in this version

type Mpesa

+ func (m *Mpesa) STKPushQuery(ctx context.Context, passkey string, req STKPushQueryRequest) (*STKPushQueryResponse, error)

+ type STKPushQueryRequest struct

+ BusinessShortCode uint

+ CheckoutRequestID string

+ Password string

+ Timestamp string

+ type STKPushQueryResponse struct

+ CheckoutRequestID string

+ ErrorCode string

+ ErrorMessage string

+ MerchantRequestID string

+ RequestID string

+ ResponseCode string

+ ResponseDescription string

+ ResultCode string

+ ResultDesc string

v1.0.5

Jul 27, 2022

Changes in this version

+ var ErrInvalidInitiatorPassword = errors.New("mpesa: initiator password cannot be empty")

+ type AuthorizationResponse struct

+ AccessToken string

+ ExpiresIn string

+ type B2CCallback struct

+ Result B2CCallbackResult

+ func UnmarshalB2CCallback(in interface{}) (*B2CCallback, error)

+ type B2CCallbackResult struct

+ ConversationID string

+ OriginatorConversationID string

+ ReferenceData B2CReferenceData

+ ResultCode int

+ ResultDesc string

+ ResultParameters B2CResultParameters

+ ResultType int

+ TransactionID string

+ type B2CReferenceData struct

+ ReferenceItem B2CReferenceItem

+ type B2CReferenceItem struct

+ Key string

+ Value string

+ type B2CRequest struct

+ Amount uint

+ CommandID string

+ InitiatorName string

+ Occasion string

+ PartyA uint

+ PartyB uint64

+ QueueTimeOutURL string

+ Remarks string

+ ResultURL string

+ SecurityCredential string

+ type B2CRequestResponse struct

+ ConversationID string

+ ErrorCode string

+ ErrorMessage string

+ OriginatorConversationID string

+ RequestID string

+ ResponseCode string

+ ResponseDescription string

+ type B2CResultParameters struct

+ ResultParameter []ResultParameter

+ type Environment string

+ const Production

+ const Sandbox

+ func (e Environment) IsProduction() bool

+ type HttpClient interface

+ Do func(req *http.Request) (*http.Response, error)

type Mpesa

+ func NewApp(c HttpClient, consumerKey, consumerSecret string, env Environment) *Mpesa

+ func (m *Mpesa) B2C(ctx context.Context, initiatorPwd string, b2cReq B2CRequest) (*B2CRequestResponse, error)

+ func (m *Mpesa) GenerateAccessToken(ctx context.Context) (string, error)

+ func (m *Mpesa) STKPush(ctx context.Context, passkey string, stkReq STKPushRequest) (*STKPushRequestResponse, error)

+ type ResultParameter struct

+ Key string

+ Value interface{}

+ type STKCallback struct

+ CallbackMetadata STKCallbackMetadata

+ CheckoutRequestID string

+ MerchantRequestID string

+ ResultCode int

+ ResultDesc string

+ type STKCallbackItem struct

+ Name string

+ Value interface{}

+ type STKCallbackMetadata struct

+ Item []STKCallbackItem

+ type STKPushCallback struct

+ Body STKPushCallbackBody

+ func UnmarshalSTKPushCallback(in interface{}) (*STKPushCallback, error)

+ type STKPushCallbackBody struct

+ STKCallback STKCallback

type STKPushRequest

+ AccountReference string

+ BusinessShortCode uint

+ CallBackURL string

+ PartyA uint

+ Password string

+ Timestamp string

+ TransactionDesc string

+ type STKPushRequestResponse struct

+ CheckoutRequestID string

+ CustomerMessage string

+ ErrorCode string

+ ErrorMessage string

+ MerchantRequestID string

+ RequestID string

+ ResponseCode string

+ ResponseDescription string

v1.0.4

May 18, 2021

Changes in this version

+ var ErrInvalidTransactionType = errors.New("mpesa: invalid transaction type provided")

+ type B2CPaymentRequest struct

+ Amount uint64

+ CommandID string

+ InitiatorName string

+ InitiatorPassword string

+ Occasion string

+ PhoneNumber uint64

+ QueueTimeOutURL string

+ Remarks string

+ ResultURL string

+ Shortcode uint

+ type B2CPaymentRequestCallback struct

+ Result struct{ ... }

+ type B2CPaymentRequestResponse struct

+ ConversationId string

+ ErrorCode string

+ ErrorMessage string

+ IsSuccessful bool

+ OriginatorConversationId string

+ RequestID string

+ ResponseDescription string

type Mpesa

+ func (m *Mpesa) B2CPayment(b *B2CPaymentRequest) (*B2CPaymentRequestResponse, error)

type STKPushRequest

+ TransactionType string

v1.0.3

May 16, 2021

Changes in this version

+ var ErrInvalidAmount = errors.New("mpesa: amount must be greater than 0")

+ var ErrInvalidBusinessShortCode = errors.New("mpesa: business shortcode must be 5 or more digits")

+ var ErrInvalidCallbackURL = errors.New("mpesa: callback URL must be a valid URL or IP")

+ var ErrInvalidPartyB = errors.New("mpesa: party B must be must be 5 or more digits")

+ var ErrInvalidPasskey = errors.New("mpesa: passkey cannot be empty")

+ var ErrInvalidPhoneNumber = errors.New("mpesa: phone number must be 12 digits and must be in international format")

+ var ErrInvalidReferenceCode = errors.New("mpesa: reference code cannot be more than 13 characters")

+ var ErrInvalidTransactionDescription = errors.New("mpesa: transaction description cannot be more than 13 characters")

+ type LipaNaMpesaOnlineCallback struct

+ Body struct{ ... }

+ type LipaNaMpesaOnlineRequestResponse struct

+ CheckoutRequestID string

+ CustomerMessage string

+ ErrorCode string

+ ErrorMessage string

+ IsSuccessful bool

+ MerchantRequestID string

+ RequestID string

+ ResponseCode string

+ ResponseDescription string

+ type Mpesa struct

+ BaseURL string

+ Cache *cache.Cache

+ ConsumerKey string

+ ConsumerSecret string

+ IsOnProduction bool

+ func Init(c *config.Credentials, isOnProduction bool) *Mpesa

+ func (m *Mpesa) Environment() string

+ func (m *Mpesa) GetAccessToken() (string, error)

+ func (m *Mpesa) LipaNaMpesaOnline(s *STKPushRequest) (*LipaNaMpesaOnlineRequestResponse, error)

+ type STKPushRequest struct

+ Amount uint64

+ CallbackURL string

+ PartyB uint

+ Passkey string

+ PhoneNumber uint64

+ ReferenceCode string

+ Shortcode uint

+ TransactionDescription string

v1.0.2

May 16, 2021

v1.0.1

May 16, 2021

v1.0.0

May 16, 2021

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL