Payment
- The user enters the amount and the bKash wallet number in the format of 01ХХХХХХХХХ, where X is a number.
The user is redirected to the bKash payment page.
- The user makes a payment on the bKash side - enters PIN, sends money.
- Paykassma sends a postback to the merchant's side.
- Funds are credited to the user’s balance on the merchant platform.
Payment window integration (plugin)
Example of a link to open a bKash payment window:
https://plugin.{ URL сервера }/?label=label¤cy_code=BDT&lang=en&wallet_type=bkash_api&custom_transaction_id=custom_transaction_id&&fixed_amount=fixed_amount&payment_url_fail_id=1 |
|---|
wallet_type=bkash_api currency_code=BDT Доступные языки (lang): en, bn
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 plugin parameters click here.
API integration
Creating payment
http://api.{ URL сервера }/api/v1/payment/create/bkash_api?secret={pluginapi_secret}
Request method:
POST
Format:
JSON
Parameters:
| Name | Type | Required | Description |
| secret | string | yes | API access key |
Body:
Name | Type | Required | Max Length | Description |
amount | float | yes | limited by min and max. | Amount of payment |
| account_number | string | yes | 11 | bKash account number, 11 digts, first - 0 |
| 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 ID in the Client's system. Must be unique. |
| success_url | string | yes | not restricted | Redirect URL to the success page after the payment. |
| failure_url | string | yes | not restricted | Redirect URL to the fail page after the payment |
| cancel_url | string | yes | not restricted | Redirect URL to cancel page |
{
"amount": 1.00,
"account_number": "01770618575",
"currency": "BDT",
"label": "test",
"custom_transaction_id": "01abc0095689",
"success_url": "https://static5.depositphotos.com/1029663/395/i/600/depositphotos_3955476-stock-photo-green-check-mark.jpg?status=success",
"failure_url": "https://top-fon.com/uploads/posts/2021-07/1626870875_29-p-krasnii-krest-fon-32.png?status=failure",
"cancel_url": "https://google.com/"
}
{
"status": "ok",
"data": {
"orderId": "1cb4627a420a6e69",
"bkashUrl": "https://sandbox.payment.bkash.com/redirect/tokenized/?paymentID=TR00114E1661778153815&hash=dcRq9geuCtjkN6rFpaGxdLAMrmyxIxL*kEN-p41SLL2M!xXy9m2OTUTLwlAGMVWDKyE8xkOHj_N_AHaTxNGT*(V2LXyC5y4zpUsG1661778154005&mode=0011&apiVersion=v1.2.0-beta",
"message": "Successful"
}
}
{
'status': 'fail'
'message': 'MESSAGE'
}
In case of a successful request to create a payment, the Client user must display the page received in the "bkashUrl" parameter.
Payment steps on Bkash page
Step 1: A form will open to enter the user's Bkash account number. You must click on "Confirm" to proceed to the next payment step.
The data on the first Bkash form is filled in automatically, because the Client’s user account number in Bkash has already been sent in the payment creation request.
Step 2. If the account number is valid, the following form will open to enter the OTP code. You must enter the OTP on the form and click on “Confirm”.
Step 3. If the OTP code is correct, the following form will open to enter the PIN. You must enter the data and click on "Confirm".
Step 4. If the PIN is correct, then Bkash will redirect the user to the url that was sent in the payment request.
The example below is for an unsuccessful payment.
After this, the Paykassma download page will be displayed to the user for some time (quite quickly, a few seconds). Example:
The download page will close and the user will be redirected to the correct page depending on the payment status:
In case of successful payment → to success_url;
In case of payment error → to failure_url
In case of payment cancellation (if the user clicked on the "Close" button in steps 1-3) → to cancel_url.
Checking payment status (Optional step)
http://api.{ URL сервера }/api/v1/payment/bkash_api/status?secret={pluginapi_secret}
Request method:
POST
Format:
JSON
Parameters:
| Name | Type | Required | Description |
| secret | string | yes | API access key |
Body:
Name | Type | Required | Max Length | Description |
order_id | string | yes | 190 | The order number received in response to the payment creation request. |
{
"order_id": "fb6fd9d57a664f61"
}
{
"status": "ok",
"data": {
"status": "success" // доступны "wait" и "fail".
}
}
{
'status': 'fail'
'message': 'MESSAGE'
}
Deposit postback
For the general documentation on post backs click here.
Example of a postback for a bKash deposit:
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.