Struct mpesa::services::AccountBalanceBuilder

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

Implementations

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

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

Creates a new AccountBalanceBuilder. Requires an initiator_name, the credential/ username used to authenticate the transaction request

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

Adds a CommandId, the unique command passed to the MPESA system. Defaults to CommandId::AccountBalance if not passed explicitly.

Errors

If CommandId is invalid

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

Adds PartyA, the shortcode of the organization receiving the transaction. This is a required field.

Errors

If Party A is not provided or invalid

pub fn identifier_type( self, identifier_type: IdentifierTypes ) -> AccountBalanceBuilder<'mpesa, Env>

Adds the ReceiverIdentifierType, the type of organization receiving the transaction. Defaults to IdentifierTypes::ShortCode if not passed explicitly

Errors

If invalid ReceiverIdentifierType is provided

pub fn remarks(self, remarks: &'mpesa str) -> AccountBalanceBuilder<'mpesa, Env>

Adds Remarks, a comment sent along transaction. Optional field that defaults to "None" if no value is provided

pub fn timeout_url( self, timeout_url: &'mpesa str ) -> AccountBalanceBuilder<'mpesa, Env>

Error

If QueueTimeoutUrl is invalid or not provided

pub fn result_url( self, result_url: &'mpesa str ) -> AccountBalanceBuilder<'mpesa, Env>

Error

If ResultUrl is invalid or not provided

pub fn urls( self, timeout_url: &'mpesa str, result_url: &'mpesa str ) -> AccountBalanceBuilder<'mpesa, Env>

👎Deprecated

Adds QueueTimeoutUrl and ResultUrl. This is a required field

Error

If either QueueTimeoutUrl and ResultUrl is invalid or not provided

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

AccountBalance API

Enquire the balance on an M-Pesa BuyGoods (Till Number). A successful request returns a C2bRegisterResponse type. See more here

Errors

Returns a MpesaError on failure

Trait Implementations

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

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

Formats the value using the given formatter.