This enables your application to send money to m-pesa registered phone number across Kenya.
BODY PARAMS
Parameter |
Data Type |
Description |
Required |
wallet_no |
string |
Business wallet account number assigned by Lemonade Payment |
Y |
reference |
alphanumeric |
Unique reference number. unique minimum:6 digit string for each transaction |
Y |
acc_name |
string |
recipient's full name. |
Y |
acc_no |
string |
the recipient's bank account number |
Y |
currency |
string |
Transaction currency By Default KES |
Y |
amount |
string |
the amount. Max per transaction is KES 999,999 |
Y |
bank_code |
string |
These are pesalink bank code provided by cbk . e.g Equity bank code is 68 |
Y |
description |
string |
any additional payment details the sender may have. |
Y |
channel |
numeric |
channel unique code. use 100002 for PESALINK |
Y |
result_url |
string |
this parameter holds the URL to your server to which callback response will be sent. |
Y |
HEADER PARAMS
Parameter |
Data Type |
Description |
Required |
Authorization |
string |
bearer token used to access the API |
Y |
200 Success Response Schema
Parameter |
Data Type |
Description |
success |
bool |
Response code |
message |
string |
Response message. |
Example Request
curl --location 'https://here-prod-api-url.com/api/v2/payment' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"wallet_no": "416533766",
"reference": "202406304231743",
"acc_name": "John Doe",
"acc_no": "0572637662XXX",
"currency": "KES",
"amount": 50,
"channel": "100002",
"bank_code": "68",
"description": "Salary payment via pesalink",
"result_url": "https://webhook.site/a8cbab63-0c7b-4c88-ac12-82812c208150"
}'
Example Response
{
"success": true,
"message": "Successfully initiated",
"data": {
"transaction_id": "909830648685",
"status": "PENDING",
"status_description": "Transaction Initiated successfully"
}
}
Example Success Transaction on the Return Url Response
{
"channel": "234432",
"reference": "12232",
"transaction_id": "909830648685",
"third_party_id": "SDLD82T35",
"currency": "KES",
"amount": "100",
"fees": "2",
"result_code": 0,
"result_description": "The service request is processed successfully.",
"hash": "d6e15ccdf590e58ac5ad4f52943fe16c4db8a605034a4565d21a86a886a7c1c4"
}