Transfer Money
Transfers money from one mobile money paybill e.g M-pesa Paybill, to another via B2B.
Once completed, it sends an Instant Transaction Notification or webhook event to your callback URL for you to process the transaction.
Endpoints
https://developer.lipisha.com/index.php/v2/api/transfer_money TEST
https://api.lipisha.com/v2/transfer_money LIVE
Request POST application/x-www-form-urlencoded
| Parameter |
Description |
Example |
| api_key |
Your Lipisha API key. |
3aa67677e8bf1d4c8fe886a38c03a860 |
| api_signature |
Your Lipisha API signature. |
SYetmwsNnb5bwaZRyeQKhZNNkCoEx+5x= |
| account_number |
Account number of the transaction account |
00500 |
| transaction_method |
The type of transfer to effect
- Paybill To Paybill (M-Pesa)
- Paybill To Bulk Pay (M-Pesa)
- Paybill To Buy Goods (M-Pesa)
|
Paybill To Paybill (M-Pesa) |
| business_number |
Shortcode of the destination paybill. |
654321 |
| business_name |
Organization name linked to the destination paybill. |
Demo Business Limited |
| mobile_number |
Mobile number linked to the destination paybill. |
254712345678 |
| email |
Email address linked to the destination paybill. |
info@demobusiness.com |
| amount |
Amount of money to send to shortcode |
1000 |
| currency |
Currency of the transaction |
KES |
| reference |
Your identifier for the transaction |
LOAN000001 |
Example Request
curl "https://developer.lipisha.com/index.php/v2/api/transfer_money" \
-X POST \
--data-urlencode "api_key=3aa67677e86a38c03a860" \
--data-urlencode "api_signature=SYetmwsNnb5bwaZRyeQKhZNNkCoEx+5x=" \
--data-urlencode "account_number=00500" \
--data-urlencode "business_number=654321" \
--data-urlencode "business_name=Demo Business Limited" \
--data-urlencode "mobile_number=254712345678" \
--data-urlencode "email=info@demobusiness.com" \
--data-urlencode "amount=1000" \
--data-urlencode "currency=KES" \
--data-urlencode "reference=LOAN000001"
Response application/json
| Parameter |
Description |
Example |
| Status |
| status |
Status of the API call |
SUCCESS |
| status_code |
Status code of the API call |
0000 |
| status_description |
Description of the API call |
Transfer Queued |
| Content |
| transaction |
Lipisha identifier for the transaction |
ABC12345QR |
| account_number |
Account number of the transaction account |
00500 |
| transaction_method |
The type of transfer to effect
- Paybill To Paybill (M-Pesa)
- Paybill To Bulk Pay (M-Pesa)
- Paybill To Buy Goods (M-Pesa)
|
Paybill To Paybill (M-Pesa) |
| business_number |
Shortcode of the destination paybill. |
654321 |
| business_name |
Organization name linked to the destination paybill. |
Demo Business Limited |
| mobile_number |
Mobile number linked to the destination paybill. |
254712345678 |
| email |
Email address linked to the destination paybill. |
info@demobusiness.com |
| amount |
Amount of money to send to shortcode |
1000 |
| currency |
Currency of the transaction |
KES |
| reference |
Your identifier for the transaction |
LOAN000001 |
Example Response
{
"status": {
"status_code": "0000",
"status_description": "Transfer Queued",
"status": "SUCCESS"
},
"content": {
"transaction": "ABC12345QR",
"account_number": "00500",
"transaction_method": "Paybill To Paybill (M-Pesa)",
"business_number": "654321",
"business_name": "Demo Business Limited",
"mobile_number": "254712345678",
"email": "info@demobusiness.com",
"amount": "1000",
"currency": "KES",
"reference": "LOAN000001"
}
}
