Lipisha REST APIs


Get Accounts


API Description

This API call returns all transaction accounts matching the specified query parameters.

API Endpoint

The API service endpoint for making the Get Transaction Account API call is:

https://developer.lipisha.com/index.php/v2/api/get_transaction_account

API Request

The API request is made via HTTP POST and must be url encoded. Some of the parameters are required while others are optional. The parameters are:

Parameter Description Example
api_key Unique string specifying merchant's Lipisha API key.

This should match the api key that you have generated for your Lipisha account
3aa67677e8bf1d4c8fe886a38c03a860
api_signature Unique string specifying merchant's Lipisha API signature.

This should match the api signature that you have generated for your Lipisha account
SYetmwsNnb5bwaZRyeQ..........KhZNNkCoEx+5x=
api_version String specifying the version of the API in use 1.3.0
api_type String specifying the type of handshake or IPN call Callback
transaction_account_name List of one or more comma-separated strings specifying the names of the transaction accounts.
Specify an empty string if parameter is not required.
Test Account, Test Account 2
transaction_account_number List of one or more comma-separated integers specifying transaction account numbers.
Specify an empty string if parameter is not required.
00155,00156
account_manager List of one or more comma-separated strings specifying the usernames of the transaction account managers.
Specify an empty string if parameter is not required.
test_user, test_user_2

API Response

The API reponse will be returned as JSON. Each response will contain a status and content section. The parameters are:

Parameter Description Example
Status
status String specifying whether API Call executed successfully or failed SUCCESS
status_code Integers specifying status code of the API Call result 0000
status_description String containing description of the status Transaction Accounts Found
Content
Array Of Transaction Accounts
account_number Integers specifying account number of existing transaction account 00155
account_type Integer specifying type of transaction account.

1 - For Mpesa Paybill Number
2 - For Airtel Money
1
account_name String specifying the name of the transaction account to be updated. Test Account
account_manager String specifying the username of the person managing the transaction account.

This is the name used to login and NOT the full name of the user. The user must already exist.
test_user

JSON Reponse
{
  "status": {
	"status_code": "0000",
	"status_description": "Transaction Accounts Found",
	"status": "SUCCESS"
  },
  "content": [
  {
	"account_type": "1",
	"account_number": "00155",
	"account_name": "Test Account",
	"account_manager": "test_user"
  },
  {
	"account_type": "1",
	"account_number": "00156",
	"account_name": "Test Account 2",
	"account_manager": "test_user_2"
  }
]     
}

Fork me on GitHub