Lipisha REST APIs


Create Account


API Description

This API call creates a new transaction account.

A transaction account is used to receive and send transaction and is entered by your customer as the account number e.g in an M-Pesa Paybill transaction or reference in Airtel Money in when they are carrying out a transaction. It is used to identify your transactions and is unique to your account.

This account can be created manually from the Transaction Accounts tab under the Settings section of your Lipisha dashboard.

API Endpoint

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

https://developer.lipisha.com/index.php/v2/api/create_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
account_type Integer specifying type of transaction account.

1 - For Mpesa Paybill/ Airtel Money
1
account_name String specifying the name of the transaction account to be created. 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

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 Account Created
Content
account_type Integer specifying type of transaction account.

1 - For Mpesa Paybill Number
2 - For Airtel Money
1
account_number Integers specifying account number assigned to your newly created transaction account 00155
account_name String specifying the name of the transaction account to be created. 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 Account Created",
    "status": "SUCCESS"
  },
  "content": {
    "account_type": "1",
    "account_number": "00155",
    "account_name": "Test Account",
    "account_manager": "test_user"
  }
}

Fork me on GitHub