Payment
- The user enters the amount and his Mpesa wallet number.
- User receives notification to the mobile.
- The user confirms the payment.
- Paykassma sends a postback to the merchant.
- The funds are credited to the user's balance on the merchant's platform.
Payment window integration (plugin)
Example of a link to open a Mpesa payment window:
https://plugin.{URL_сервера}/?label=label¤cy_code=KES&lang=en&wallet_type=mpesa&custom_transaction_id=custom_transaction_id&fixed_amount=fixed_amount&payment_url_fail_id=1 |
|---|
wallet_type=mpesa currency_code=KES Available languages (lang): en
Pay attention to the description of the parameters payment_url_success_id / payment_url_fail_id/ payment_url_pending_id and success_url / fail_url / pending_url.
To use payment_url_success_id / payment_url_fail_id / payment_url_pending_id you need to send the URLs to Paykassma support and use the received IDs in the parameters.
To use success_url / fail_url / pending_url you must use hashing URLs ( For more details on hashing click here ).
For the description of all the plug-in parameters click here.
API integration
Payment creation
URL: http://api.{ server URL }/api/v1/payment/create/mpesa?secret={ pluginapi_secret }
Request method:
POST
Format:
JSON
Parameters:
| Name | Type | Required | Description |
| secret | string | yes | Access key |
Body:
Name | Type | Required | Max Length | Description |
amount | float | yes | is limited to min and max. | Payment amount |
| phone_number | string | yes | 12 | MSISDN (12-digit cell phone number), e.g. 2547XXXXXXXX. |
| currency | string | yes | 3 | Currency code |
| label | string | yes | 190 | The unique identifier (ID) of the user who makes the payment. |
| custom_transaction_id | string | yes | 190 | Transaction identifier in the Client's system. Must be unique. |
{
"amount": 1000,
"phone_number": "254712344321",
"currency": "KES",
"label": "test",
"custom_transaction_id": "01abc0095689"
}
{
"status": "ok",
"data": {
"order_id": "e5c0637c10d326f7",
"message": "Success. Request accepted for processing"
}
}
{
'status': 'fail',
'message': 'MESSAGE'
}
Deposit postback
For the general documentation on post backs click here.
Example of a deposit postback for Mpesa
The Paykassma server is waiting for a response in json {"status": "ok"} response code 200, otherwise, when receiving a different response, Paykassma will forward the postback with a certain frequency.
Repeated postbacks must also be answered with {"status":"ok"} response code 200.
Withdrawals for users
For the general documentation on the withdrawals of funds click here.
Withdrawal request
URL: https://api.{ server URL }/v2/withdrawal/create
Request method:
POST
Format:
JSON
Parameters:
Name | Type | Required | Description |
| withdrawal_id | string | yes | Withdrawal ID, if the parameter is not passed, then the system generates withdrawal _id. |
| payment_system | string | yes | Payment system |
| amount | int | required | Additional requirements:
|
| currency_code | string | yes | Currency code |
is_test | boolean | yes | The is_test parameter possible values: true - if Withdrawal is test |
label | string | yes | The unique identifier (ID) of the user who makes the payment. |
| account_number | string | yes | MSISDN (12-digit cell phone number), e.g. 2547XXXXXXXX. |
| signature | string | yes | Signature generated with private_key. |
{
"withdrawal_id": "85858053",
"payment_system": "mpesa",
"amount": 1000,
"currency_code": "KES",
"label": "160496026",
"comment": "withdrawal",
"account_number": "254724653314",
"is_test": true,
"signature": "2266a77c54925494335c12d365bdbf67f7e6e9c6"
}
{
"status": "ok",
}
{
'status': 'fail',
'message': 'MESSAGE'
}
*If, when trying to create a withdrawal request, the amount of account balances in the currency of the request is less than the total amount of new and still incomplete applications, the error message"Insufficient balance" will be displayed (to configure this functionality, contact the TP Paykassma).
{
"status": "fail",
"message": {
"withdrawals_sum_amount": [
"Insufficient balance"
]
}
}
Example of a postback for a Mpesa withdrawal
The Paykassma server is waiting for a response in json {"status": "ok"} response code 200, otherwise, when receiving a different response, Paykassma will forward the postback with a certain frequency.
Repeated postbacks must also be answered with {"status":"ok"} response code 200.
After processing the withdrawal, Paykassma will send a postback about the withdrawal result with status, signed with a signature.
Withdrawal statuses
| 1 | SUCCESS | Status for withdrawal when the withdrawal request has been successfully processed |
| 5 | FAIL | Status for withdrawal when the withdrawal request was rejected |
Creating withdrawal request in Paykassma BO
To create a withdrawal request, you need to go to the Withdrawals page Payments → Withdrawals and perform the following steps.
1. Press the button "Add withdrawal request".
2. Select payment system from list.
3. Fill in the fields to create the request in the next window (the list of fields is standardized and not all fields are required. To create a request for a specific PS, you should fill in the required fields for this PS).
Required fields for bKash payout:
- Label (user ID)
- Amount
- Currency code
- Wallet recipient
4. After payment the withdrawal status will change.
Paykassma does not send postback for withdrawals created manually.