def add_mobile_wallet_settlement_account(self, kwargs): """ Creates a verified settlement bank account. Returns a request response object < class, 'requests.models.Response'> :param kwargs: The values constitute all user input. :type kwargs: dict :return: requests.models.Response """ if 'access_token' not in kwargs: raise exceptions.InvalidArgumentError('Access Token not given.') if 'first_name' not in kwargs or \ 'last_name' not in kwargs or \ 'phone_number' not in kwargs or \ 'network' not in kwargs: raise exceptions.InvalidArgumentError( 'Invalid arguments for creating Outgoing Pay.') # iterate through kwargs if 'access_token' in kwargs: bearer_token = kwargs['access_token'] if 'first_name' in kwargs: first_name = kwargs['first_name'] if 'last_name' in kwargs: last_name = kwargs['last_name'] if 'phone_number' in kwargs: phone_number = kwargs['phone_number'] if 'network' in kwargs: network = kwargs['network'] # build url create_mobile_wallet_settlement_account_url = self._build_url( SETTLEMENT_MOBILE_ACCOUNTS_PATH) # define headers headers = dict(self._headers) # validate string arguments validation.validate_string_arguments(bearer_token, first_name, last_name, phone_number, network) validation.validate_phone_number(phone_number) # add authorization to headers headers['Authorization'] = 'Bearer ' + bearer_token + '' # define create mobile settlement account payload create_mobile_settlement_account_payload = json_builder.mobile_settlement_account( first_name=first_name, last_name=last_name, phone_number=phone_number, network=network) return self._make_requests( headers=headers, method='POST', url=create_mobile_wallet_settlement_account_url, payload=create_mobile_settlement_account_payload)
def add_pay_recipient(self, kwargs): """ Adds external entities that will be the destination of your payments. Returns a request response object < class, 'requests.models.Response'> :param kwargs: The values constitute all user input. :type kwargs: dict :return:'requests.models.Response' """ if 'access_token' not in kwargs: raise exceptions.InvalidArgumentError('Access Token not given.') if 'recipient_type' not in kwargs: raise exceptions.InvalidArgumentError('Recipient Type not given.') if 'access_token' in kwargs: bearer_token = kwargs['access_token'] if 'recipient_type' in kwargs: recipient_type = kwargs['recipient_type'] # define headers headers = dict(self._headers) validation.validate_string_arguments(bearer_token) # add bearer token headers['Authorization'] = 'Bearer ' + bearer_token # build url add_pay_url = self._build_url(url_path=ADD_PAY_PATH) if 'email' in kwargs: validation.validate_email(str(kwargs['email'])) if 'phone_number' in kwargs: validation.validate_phone_number(str(kwargs['phone_number'])) # expected parameters for bank account wallet recipient if recipient_type == BANK_ACCOUNT_RECIPIENT_TYPE: if 'account_name' not in kwargs or \ 'account_number' not in kwargs or \ 'settlement_method' not in kwargs or \ 'bank_branch_ref' not in kwargs: raise exceptions.InvalidArgumentError( 'Invalid arguments for bank account Pay recipient') # build recipient json object recipient_object = json_builder.bank_account( account_name=str(kwargs['account_name']), account_number=str(kwargs['account_number']), settlement_method=str(kwargs['settlement_method']), bank_branch_ref=str(kwargs['bank_branch_ref'])) # build bank payment recipient json object payment_recipient_object = json_builder.pay_recipient( recipient_type=recipient_type, recipient=recipient_object) # expected parameters for mobile wallet recipient # ['first_name', 'last_name', # network','phone_number','email'] elif recipient_type == MOBILE_WALLET_RECIPIENT_TYPE: if 'first_name' not in kwargs or \ 'last_name' not in kwargs or \ 'phone_number' not in kwargs or \ 'email' not in kwargs or \ 'network' not in kwargs: raise exceptions.InvalidArgumentError( 'Invalid arguments for mobile wallet Pay recipient') # create recipient json object recipient_object = json_builder.mobile_wallet( first_name=str(kwargs['first_name']), last_name=str(kwargs['last_name']), phone_number=str(kwargs['phone_number']), network=str(kwargs['network']), email=str(kwargs['email'])) # create mobile wallet recipient json object payment_recipient_object = json_builder.pay_recipient( recipient_type=recipient_type, recipient=recipient_object) elif recipient_type == TILL_RECIPIENT_TYPE: if 'till_name' not in kwargs or \ 'till_number' not in kwargs: raise exceptions.InvalidArgumentError( 'Invalid arguments for till Pay recipient') # create recipient json object recipient_object = json_builder.till_pay_recipient( till_name=str(kwargs['till_name']), till_number=str(kwargs['till_number'])) # create mobile wallet recipient json object payment_recipient_object = json_builder.pay_recipient( recipient_type=recipient_type, recipient=recipient_object) # expected parameters for mobile wallet recipient # ['till_name', 'till_number'] elif recipient_type == PAYBILL_RECIPIENT_TYPE: if 'paybill_name' not in kwargs or \ 'paybill_number' not in kwargs or \ 'paybill_account_number' not in kwargs: raise exceptions.InvalidArgumentError( 'Invalid arguments for paybill Pay recipient') # create recipient json object recipient_object = json_builder.paybill_pay_recipient( paybill_name=str(kwargs['paybill_name']), paybill_number=str(kwargs['paybill_number']), paybill_account_number=str(kwargs['paybill_account_number'])) # create mobile wallet recipient json object payment_recipient_object = json_builder.pay_recipient( recipient_type=recipient_type, recipient=recipient_object) # expected parameters for mobile wallet recipient # ['alias_name', 'till_number'] else: raise exceptions.InvalidArgumentError( 'The recipient type is not recognized by k2connect') return self._make_requests(headers=headers, method='POST', url=add_pay_url, payload=payment_recipient_object)
def create_payment_request(self, kwargs): """ Creates a request for the reception of payments from MPESA users. Returns a request response object < class, 'requests.models.Response'> :param kwargs: The values constitute all user input. :type kwargs: dict :return: requests.models.Response """ if 'access_token' not in kwargs: raise exceptions.InvalidArgumentError('Access Token not given.') if 'first_name' not in kwargs or \ 'last_name' not in kwargs or \ 'callback_url' not in kwargs or \ 'payment_channel' not in kwargs or \ 'phone_number' not in kwargs or \ 'till_number' not in kwargs or \ 'email' not in kwargs or \ 'amount' not in kwargs: raise exceptions.InvalidArgumentError('Invalid arguments for creating Incoming Payment Request.') if 'currency' not in kwargs: currency = 'KES' if 'metadata' not in kwargs: mpesa_payment_metadata = '' # iterate through kwargs if 'access_token' in kwargs: bearer_token = kwargs['access_token'] if 'phone_number' in kwargs: phone_number = kwargs['phone_number'] if validation.validate_phone_number(phone_number) is False: pass if 'email' in kwargs: email = kwargs['email'] validation.validate_email(email) if 'currency' in kwargs: currency = 'KES' if 'metadata' in kwargs: mpesa_payment_metadata = json_builder.metadata(kwargs['pay_metadata']) # define headers headers = dict(self._headers) # validate bearer_token validation.validate_string_arguments(bearer_token) # add bearer token headers['Authorization'] = 'Bearer ' + bearer_token + '' # build create mpesa payment request url mpesa_payment_request_url = self._build_url(CREATE_RECEIVE_MPESA_PAYMENT_PATH) # define amount JSON object mpesa_payment_request_amount = json_builder.amount(currency=currency, value=kwargs['amount']) # define links JSON object mpesa_payment_request_links = json_builder.links(callback_url=kwargs['callback_url']) # define subscriber JSON object mpesa_payment_subscriber = json_builder.subscriber(first_name=kwargs['first_name'], last_name=kwargs['last_name'], phone_number=phone_number, email=email) # define MPESA payment request JSON object mpesa_payment_request_payload = json_builder.mpesa_payment(mpesa_links=mpesa_payment_request_links, mpesa_payment_amount=mpesa_payment_request_amount, mpesa_payment_subscriber=mpesa_payment_subscriber, metadata=mpesa_payment_metadata, payment_channel=kwargs['payment_channel'], till_number=kwargs['till_number']) return self._make_requests(headers=headers, method='POST', url=mpesa_payment_request_url, payload=mpesa_payment_request_payload)
def create_payment_request(self, bearer_token, callback_url, first_name, last_name, payment_channel, phone, till_number, value, currency='KES', **kwargs): """ Creates a request for the reception of payments from MPESA users. Returns a request response object < class, 'requests.models.Response'> :param bearer_token: Access token to be used to make calls to the Kopo Kopo API. :type bearer_token: str :param callback_url: Callback URL where the result of the MPESA payment request will be posted. :type callback_url: str :param currency: Currency of amount being transacted :type currency: str :param first_name: First name of the subscriber. :type first_name: str :param last_name: Last name of the subscriber. :type last_name: str :param phone: Phone number of the subscriber from which the payment will be made. :type phone: str :param payment_channel: Payment channel to be used eg. MPESA. :type payment_channel: str :param till_number: Till to which the payment will be made. :type till_number: str :param value: Value of money to be received :type value: str :param kwargs: :type kwargs: dict :return: requests.models.Response """ # validate phone number if validation.validate_phone_number(phone) is False: pass # validate email address if present if 'email' in kwargs: validation.validate_email(str(kwargs['email'])) email = kwargs['email'] else: email = 'Null' # define headers headers = dict(self.headers) # validate bearer_token validation.validate_string_arguments(bearer_token) # add bearer token headers['Authorization'] = 'Bearer ' + bearer_token + '' # build create mpesa payment request url mpesa_payment_request_url = self._build_url( CREATE_RECEIVE_MPESA_PAYMENT_PATH) # define amount JSON object mpesa_payment_request_amount = json_builder.amount(currency=currency, value=value) # define links JSON object mpesa_payment_request_links = json_builder.links( callback_url=callback_url) # define metadata JSON object mpesa_payment_metadata = json_builder.metadata(', '.join( ['{}={}'.format(k, v) for k, v in kwargs.items()])) # define subscriber JSON object mpesa_payment_subscriber = json_builder.subscriber( first_name=first_name, last_name=last_name, phone=phone, email=email) # define MPESA payment request JSON object mpesa_payment_request_payload = json_builder.mpesa_payment( mpesa_links=mpesa_payment_request_links, mpesa_payment_amount=mpesa_payment_request_amount, mpesa_payment_subscriber=mpesa_payment_subscriber, metadata=mpesa_payment_metadata, payment_channel=payment_channel, till_number=till_number) return self._make_requests(headers=headers, method='POST', url=mpesa_payment_request_url, payload=mpesa_payment_request_payload)
def add_pay_recipient(self, bearer_token, recipient_type, **kwargs): """ Adds external entities that will be the destination of your payments. Returns a request response object < class, 'requests.models.Response'> :param bearer_token: Access token to be used to make calls to the Kopo Kopo API :type bearer_token: str :param recipient_type: The type of wallet to which pay will be sent. Example: recipient_type = BANK_ACCOUNT_RECIPIENT_TYPE :type recipient_type: str :param kwargs: The values thAccess token to be used to make calls to the Kopo Kopo APIat constitute recipient types. :type kwargs: dict :return:'requests.models.Response' """ # define headers headers = dict(self._headers) validation.validate_string_arguments(bearer_token) # add bearer token headers['Authorization'] = 'Bearer ' + bearer_token + '' # build url add_pay_url = self._build_url(url_path=ADD_PAY_PATH) if 'email' in kwargs: validation.validate_email(str(kwargs['email'])) if 'phone' in kwargs: validation.validate_phone_number(str(kwargs['phone'])) # expected parameters for bank account wallet recipient # ['account_name', 'account_number', # 'bank_branch_id','bank_id', name'] if recipient_type == BANK_ACCOUNT_RECIPIENT_TYPE: if 'account_name' not in kwargs or \ 'account_number' not in kwargs or \ 'bank_branch_id' not in kwargs or \ 'bank_id' not in kwargs or \ 'name' not in kwargs: raise exceptions.InvalidArgumentError( 'Invalid arguments for bank account') # build recipient json object recipient_object = json_builder.bank_account( account_name=str(kwargs['account_name']), account_number=str(kwargs['account_number']), bank_branch_id=str(kwargs['bank_branch_id']), bank_id=str(kwargs['bank_id']), name=str(kwargs['name']), email=None, phone=None) # build bank payment recipient json object payment_recipient_object = json_builder.pay_recipient( recipient_type=recipient_type, recipient=recipient_object) # expected parameters for mobile wallet recipient # ['first_name', 'last_name', # network','phone','email'] elif recipient_type == MOBILE_WALLET_RECIPIENT_TYPE: if 'first_name' not in kwargs or \ 'last_name' not in kwargs or \ 'phone' not in kwargs or \ 'network' not in kwargs: raise exceptions.InvalidArgumentError( 'Invalid arguments for mobile wallet') # create recipient json object recipient_object = json_builder.mobile_wallet( first_name=str(kwargs['first_name']), last_name=str(kwargs['last_name']), phone=str(kwargs['phone']), network=str(kwargs['network']), email=None) # create mobile wallet recipient json object payment_recipient_object = json_builder.pay_recipient( recipient_type=recipient_type, recipient=recipient_object) else: raise exceptions.InvalidArgumentError( 'The recipient type is not recognized by k2connect') return self._make_requests( headers=headers, method='POST', payload=payment_recipient_object, url=add_pay_url, )