Struct mpesa::services::AccountBalanceBuilder

pub struct AccountBalanceBuilder<'a> { /* fields omitted */ }

Implementations

impl<'a> AccountBalanceBuilder<'a>

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

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<'a>

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: &'a str) -> AccountBalanceBuilder<'a>

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<'a>

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: &'a str) -> AccountBalanceBuilder<'a>

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: &'a str) -> AccountBalanceBuilder<'a>

Error

If QueueTimeoutUrl is invalid or not provided

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

Error

If ResultUrl is invalid or not provided

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

👎 Deprecated

Adds QueueTimeoutUrl and ResultUrl. This is a required field

Error

If either QueueTimeoutUrl and ResultUrl is invalid or not provided

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

AccountBalance API

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

Errors

Returns a MpesaError on failure

Trait Implementations

impl<'a> Debug for AccountBalanceBuilder<'a>

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

Formats the value using the given formatter.