Struct mpesa::services::MpesaExpressRequestBuilder

pub struct MpesaExpressRequestBuilder<'mpesa, Env: ApiEnvironment> { /* private fields */ }

Implementations

impl<'mpesa, Env: ApiEnvironment> MpesaExpressRequestBuilder<'mpesa, Env>

pub fn new( client: &'mpesa Mpesa<Env>, business_short_code: &'mpesa str ) -> MpesaExpressRequestBuilder<'mpesa, Env>

pub fn business_short_code(&'mpesa self) -> &'mpesa str

Public method get the business_short_code

pub fn pass_key( self, pass_key: &'mpesa str ) -> MpesaExpressRequestBuilder<'mpesa, Env>

Your passkey. Optional in sandbox, will default to key provided in Safaricom’s test credentials Required in production

Errors

If thee pass_key is invalid

pub fn amount<Number: Into<f64>>( self, amount: Number ) -> MpesaExpressRequestBuilder<'mpesa, Env>

Adds an amount to the request This is a required field

pub fn phone_number( self, phone_number: &'mpesa str ) -> MpesaExpressRequestBuilder<'mpesa, Env>

The MSISDN sending the funds

Errors

If phone_number is invalid

pub fn callback_url( self, callback_url: &'mpesa str ) -> MpesaExpressRequestBuilder<'mpesa, Env>

The url to where responses from M-Pesa will be sent to.

Errors

If the callback_url is invalid

pub fn party_a( self, party_a: &'mpesa str ) -> MpesaExpressRequestBuilder<'mpesa, Env>

The MSISDN sending the funds

Errors

If party_a is invalid

pub fn party_b( self, party_b: &'mpesa str ) -> MpesaExpressRequestBuilder<'mpesa, Env>

The organization shortcode receiving the funds

Errors

If party_b is invalid

pub fn account_ref( self, account_ref: &'mpesa str ) -> MpesaExpressRequestBuilder<'mpesa, Env>

Optional - Used with M-Pesa PayBills.

pub fn transaction_type( self, command_id: CommandId ) -> MpesaExpressRequestBuilder<'mpesa, Env>

Optional, defaults to CommandId::CustomerPayBillOnline

Errors

If the CommandId is invalid

pub fn transaction_desc( self, description: &'mpesa str ) -> MpesaExpressRequestBuilder<'mpesa, Env>

A description of the transaction. Optional - defaults to “None”

pub async fn send(self) -> MpesaResult<MpesaExpressRequestResponse>

Lipa na M-Pesa Online Payment / Mpesa Express/ Stk push

Initiates a M-Pesa transaction on behalf of a customer using STK Push

A sucessfult request returns a MpesaExpressRequestResponse type

Errors

Returns a MpesaError on failure