Struct mpesa::services::C2bSimulateBuilder

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

Implementations

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

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

Creates a new C2B Simulate builder

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

Adds CommandId. Defaults to CommandId::CustomerPaybillOnline if no value explicitly passed

Errors

If CommandId is not valid

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

Adds an amount to the request

Errors

If Amount is not provided

pub fn msisdn(self, msisdn: &'mpesa str) -> C2bSimulateBuilder<'mpesa, Env>

Adds the MSISDN(phone number) sending the transaction, start by country code without the +. This is a required field

Errors

If MSISDN is invalid or not provided

pub fn short_code( self, short_code: &'mpesa str ) -> C2bSimulateBuilder<'mpesa, Env>

Adds ShortCode; the 6 digit MPESA Till Number or PayBill Number

Errors

If Till or PayBill number is invalid or not provided

pub fn bill_ref_number( self, bill_ref_number: &'mpesa str ) -> C2bSimulateBuilder<'mpesa, Env>

Adds Bill reference number.

Errors

If BillRefNumber is invalid or not provided

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

C2B Simulate API

Make payment requests from Client to Business

This enables you to receive the payment requests in real time. See more here

A successful request returns a C2bSimulateResponse type

Errors

Returns a MpesaError on failure

Trait Implementations

impl<'mpesa, Env: Debug + ApiEnvironment> Debug for C2bSimulateBuilder<'mpesa, Env>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.