Struct OnboardBuilder 

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

Implementations

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

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

Creates a new Bill Manager Onboard builder

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

Adds callbackUrl.

Errors

If ’callbackUrl` is not provided.

pub fn email(self, email: &'mpesa str) -> OnboardBuilder<'mpesa, Env>

Adds an email address to the request.

Errors

If email is not provided.

pub fn logo(self, logo: &'mpesa str) -> OnboardBuilder<'mpesa, Env>

Adds logo; a file with your organizions’s logo.

Errors

If logo is not provided.

pub fn official_contact( self, official_contact: &'mpesa str, ) -> OnboardBuilder<'mpesa, Env>

Adds officialContact to the request; must be in the format 07XXXXXXXX

Errors

If officialContact is invalid or not provided.

pub fn send_reminders( self, send_reminders: SendRemindersTypes, ) -> OnboardBuilder<'mpesa, Env>

Adds sendReminders. Defaults to SendRemindersTypes::Disable if no value is explicitely passed.

Errors

If sendReminders is not valid.

pub fn short_code(self, short_code: &'mpesa str) -> OnboardBuilder<'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 async fn send(self) -> MpesaResult<OnboardResponse>

Bill Manager Onboarding API

Opt in as a biller to mpesa’s bill manager features.

A successful request returns a OnboardResponse type

Errors

Returns an MpesaError on failure

Trait Implementations

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

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

Formats the value using the given formatter.