lipisha package¶
Submodules¶
lipisha.api_config module¶
lipisha.lipisha module¶
-
class
lipisha.lipisha.
Lipisha
(api_key, api_signature, api_environment='live', api_version='1.3.0', opener_handlers=[])[source]¶ Bases:
object
API Client Implementation
This class instantiates a client to the Lipisha API. Initialization parameters are defined below
Parameters: - api_key – Lipisha API Key
- api_signature – Lipisha API Signature
- api_environment – This can either be “live” or “test”. Test environment will use the Lipisha sandbox
- api_version – Lipisha API Version (Defaults to DEFAULT_API_VERSION)
- opener_handlers – instances of handlers to customize urllib.build_opener behaviour. this may be used to customize the how connections to Lipisha are invoved e.g. Proxy connections..
-
acknowledge_transaction
(**kwargs)¶ API Method: acknowledge_transaction
API_URL: https://lipisha.com/payments/accounts/index.php/v2/api/acknowledge_transaction
DOCUMENTATION: http://developer.lipisha.com/index.php/app/launch/api_acknowledge_transaction
Required Parameters:
Parameters: transaction – Transaction Optional Parameters:
Parameters: - api_version – Api Version
- api_type – Api Type
API Method: authorize_card_transaction
API_URL: https://lipisha.com/payments/accounts/index.php/v2/api/authorize_card_transaction
DOCUMENTATION: http://developer.lipisha.com/index.php/app/launch/api_authorize_card_transaction
Required Parameters:
Parameters: - account_number – Account Number
- card_number – Card Number
- address1 – Address1
- address2 – Address2
- expiry – Expiry
- name – Name
- country – Country
- state – State
- zip – Zip
- security_code – Security Code
- amount – Amount
- currency – Currency
Optional Parameters:
Parameters: - api_version – Api Version
- api_type – Api Type
-
complete_card_transaction
(**kwargs)¶ API Method: complete_card_transaction
API_URL: https://lipisha.com/payments/accounts/index.php/v2/api/complete_card_transaction
DOCUMENTATION: http://developer.lipisha.com/index.php/app/launch/api_complete_card_transaction
Required Parameters:
Parameters: - transaction_index – Transaction Index
- transaction_reference – Transaction Reference
Optional Parameters:
Parameters: - api_version – Api Version
- api_type – Api Type
-
confirm_transaction
(**kwargs)¶ API Method: confirm_transaction
API_URL: https://lipisha.com/payments/accounts/index.php/v2/api/confirm_transaction
DOCUMENTATION: http://developer.lipisha.com/index.php/app/launch/api_confirm_transaction
Required Parameters:
Parameters: transaction – Transaction Optional Parameters:
Parameters: - api_version – Api Version
- api_type – Api Type
-
create_payment_account
(**kwargs)¶ API Method: create_payment_account
API_URL: https://lipisha.com/payments/accounts/index.php/v2/api/create_payment_account
DOCUMENTATION: http://developer.lipisha.com/index.php/app/launch/api_create_payment_account
Required Parameters:
Parameters: - transaction_account_type – Transaction Account Type
- transaction_account_name – Transaction Account Name
- transaction_account_manager – Transaction Account Manager
Optional Parameters:
Parameters: - api_version – Api Version
- api_type – Api Type
-
create_user
(**kwargs)¶ API Method: create_user
API_URL: https://lipisha.com/payments/accounts/index.php/v2/api/create_user
DOCUMENTATION: http://developer.lipisha.com/index.php/app/launch/api_create_user
Required Parameters:
Parameters: - full_name – Full Name
- role – Role
- mobile_number – Mobile Number
- email – Email
- user_name – User Name
- password – Password
Optional Parameters:
Parameters: - api_version – Api Version
- api_type – Api Type
-
create_withdrawal_account
(**kwargs)¶ API Method: create_withdrawal_account
API_URL: https://lipisha.com/payments/accounts/index.php/v2/api/create_withdrawal_account
DOCUMENTATION: http://developer.lipisha.com/index.php/app/launch/api_create_withdrawal_account
Required Parameters:
Parameters: - transaction_account_type – Transaction Account Type
- transaction_account_name – Transaction Account Name
- transaction_account_number – Transaction Account Number
- transaction_account_bank_name – Transaction Account Bank Name
- transaction_account_bank_branch – Transaction Account Bank Branch
- transaction_account_bank_address – Transaction Account Bank Address
- transaction_account_swift_code – Transaction Account Swift Code
- transaction_account_manager – Transaction Account Manager
Optional Parameters:
Parameters: - api_version – Api Version
- api_type – Api Type
-
get_balance
(**kwargs)¶ API Method: get_balance
API_URL: https://lipisha.com/payments/accounts/index.php/v2/api/get_balance
DOCUMENTATION: http://developer.lipisha.com/index.php/app/launch/api_get_balance
Required Parameters:
Parameters: api_type – Api Type Optional Parameters:
Parameters: - api_version – Api Version
- api_type – Api Type
-
get_customers
(**kwargs)¶ API Method: get_customers
API_URL: https://lipisha.com/payments/accounts/index.php/v2/api/get_customers
DOCUMENTATION: http://developer.lipisha.com/index.php/app/launch/api_get_customers
Required Parameters:
Optional Parameters:
Parameters: - customer_name – Customer Name
- customer_mobile_number – Customer Mobile Number
- customer_email – Customer Email
- customer_first_payment_from – Customer First Payment From
- customer_first_payment_to – Customer First Payment To
- customer_last_payment_from – Customer Last Payment From
- customer_last_payment_to – Customer Last Payment To
- customer_payments_minimum – Customer Payments Minimum
- customer_payments_maximum – Customer Payments Maximum
- customer_total_spent_minimum – Customer Total Spent Minimum
- customer_total_spent_maximum – Customer Total Spent Maximum
- customer_average_spent_minimum – Customer Average Spent Minimum
- customer_average_spent_maximum – Customer Average Spent Maximum
- limit – Limit
- offset – Offset
- api_version – Api Version
- api_type – Api Type
-
get_float
(**kwargs)¶ API Method: get_float
API_URL: https://lipisha.com/payments/accounts/index.php/v2/api/get_float
DOCUMENTATION: http://developer.lipisha.com/index.php/app/launch/api_get_float
Required Parameters:
Parameters: account_number – Account Number Optional Parameters:
Parameters: - api_version – Api Version
- api_type – Api Type
-
get_transactions
(**kwargs)¶ API Method: get_transactions
API_URL: https://lipisha.com/payments/accounts/index.php/v2/api/get_transactions
DOCUMENTATION: http://developer.lipisha.com/index.php/app/launch/api_get_transactions
Required Parameters:
Optional Parameters:
Parameters: - transaction – Transaction
- transaction_type – Transaction Type
- transaction_method – Transaction Method
- transaction_date_start – Transaction Date Start
- transaction_date_end – Transaction Date End
- transaction_account_name – Transaction Account Name
- transaction_account_number – Transaction Account Number
- transaction_reference – Transaction Reference
- transaction_amount_minimum – Transaction Amount Minimum
- transaction_amount_maximum – Transaction Amount Maximum
- transaction_status – Transaction Status
- transaction_name – Transaction Name
- transaction_mobile_number – Transaction Mobile Number
- transaction_email – Transaction Email
- limit – Limit
- offset – Offset
- api_version – Api Version
- api_type – Api Type
-
request_settlement
(**kwargs)¶ API Method: request_settlement
API_URL: https://lipisha.com/payments/accounts/index.php/v2/api/request_settlement
DOCUMENTATION: http://developer.lipisha.com/index.php/app/launch/api_request_settlement
Required Parameters:
Parameters: - account_number – Account Number
- amount – Amount
Optional Parameters:
Parameters: - api_version – Api Version
- api_type – Api Type
-
reverse_card_transaction
(**kwargs)¶ API Method: reverse_card_transaction
API_URL: https://lipisha.com/payments/accounts/index.php/v2/api/reverse_card_transaction
DOCUMENTATION: http://developer.lipisha.com/index.php/app/launch/api_reverse_card_transaction
Required Parameters:
Parameters: - transaction_index – Transaction Index
- transaction_reference – Transaction Reference
Optional Parameters:
Parameters: - api_version – Api Version
- api_type – Api Type
-
reverse_transaction
(**kwargs)¶ API Method: reverse_transaction
API_URL: https://lipisha.com/payments/accounts/index.php/v2/api/reverse_transaction
DOCUMENTATION: http://developer.lipisha.com/index.php/app/launch/api_reverse_transaction
Required Parameters:
Parameters: transaction – Transaction Optional Parameters:
Parameters: - api_version – Api Version
- api_type – Api Type
-
send_airtime
(**kwargs)¶ API Method: send_airtime
API_URL: https://lipisha.com/payments/accounts/index.php/v2/api/send_airtime
DOCUMENTATION: http://developer.lipisha.com/index.php/app/launch/api_send_airtime
Required Parameters:
Parameters: - account_number – Account Number
- mobile_number – Mobile Number
- amount – Amount
- network – Network
Optional Parameters:
Parameters: - api_version – Api Version
- api_type – Api Type
-
send_money
(**kwargs)¶ API Method: send_money
API_URL: https://lipisha.com/payments/accounts/index.php/v2/api/send_money
DOCUMENTATION: http://developer.lipisha.com/index.php/app/launch/api_send_money
Required Parameters:
Parameters: - account_number – Account Number
- mobile_number – Mobile Number
- amount – Amount
Optional Parameters:
Parameters: - api_version – Api Version
- api_type – Api Type
-
send_sms
(**kwargs)¶ API Method: send_sms
API_URL: https://lipisha.com/payments/accounts/index.php/v2/api/send_sms
DOCUMENTATION: http://developer.lipisha.com/index.php/app/launch/api_send_sms
Required Parameters:
Parameters: - mobile_number – Mobile Number
- message – Message
Optional Parameters:
Parameters: - api_version – Api Version
- api_type – Api Type
-
update_user
(**kwargs)¶ API Method: update_user
API_URL: https://lipisha.com/payments/accounts/index.php/v2/api/update_user
DOCUMENTATION: http://developer.lipisha.com/index.php/app/launch/api_update_user
Required Parameters:
Parameters: - full_name – Full Name
- role – Role
- mobile_number – Mobile Number
- email – Email
- user_name – User Name
Optional Parameters:
Parameters: - api_version – Api Version
- api_type – Api Type
-
void_card_transaction
(**kwargs)¶ API Method: void_card_transaction
API_URL: https://lipisha.com/payments/accounts/index.php/v2/api/void_card_transaction
DOCUMENTATION: http://developer.lipisha.com/index.php/app/launch/api_void_card_transaction
Required Parameters:
Parameters: - transaction_index – Transaction Index
- transaction_reference – Transaction Reference
Optional Parameters:
Parameters: - api_version – Api Version
- api_type – Api Type