Payment
- The user is provided with wallet details to which payment must be made.
- The user makes a payment in their wallet app and receives a unique transaction number.
- Next, the user enters a unique transaction number in the payment window, after which the transaction is activated.
- 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 KBZpay Manual payment window:
|
|---|
wallet_type=kbzpay_manual currency_code=MMK Available languages (lang): en, my
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
Creating payment
URL: https://api.{server_URL}/api/v1/transaction/create/kbzpay_manual?secret={pluginapi_secret}
At this stage we first accept a request for input through the payment system and in response we will provide the wallet details to which the user should transfer the payment. After the payment is made you will need to send a request to activate the transaction.
Request method:
POST
Format:
JSON
Parameters:
Name | Type | Required | Max Length | Description |
| currency | string | yes | 3 | Currency code. |
label | string | yes | 190 | The unique identifier (ID) of the user who makes the payment. |
{
'currency': 'MMK',
'label': 'eligendi'
}
{
"status": "ok",
"params": {
"kbzpay number": "12321"
}
}
{
'status': 'fail',
'message': 'MESSAGE'
}
Activation request
URL: http://api.{server_URL}/api/v1/possible-transaction?secret={pluginapi_secret}
Request method:
POST
Format:
form-data
Parameters:
Name | Type | Required | Max Length | Description |
| currency_code | string | yes | 3 | Currency code (MMK). |
wallet_type | string | yes | 190 | kbzpay_manual |
| label | string | yes | 190 | The unique identifier (ID) of the user who makes the payment. |
| key1 | string | yes | 25 | Transaction ID received from the use (15-25 digits). |
| screenshot | file | yes | Screenshot of the payment from the user. | |
| amount | int | yes | 256 | Payment amount. |
| custom_transaction_id | string | yes | 190 | The identifier of the transaction in the Client's system. Must be unique. |
{
"status": "success",
"message": "",
"code": 20000,
"data": [],
"paginate": {
"offset": 0,
"total": 1,
"limit": 1
}
}
{
'status': 'fail',
'message': 'MESSAGE'
}
Deposit postback
For the general documentation on post backs click here.
Example of a deposit postback for a KBZpay Manual
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.
Creating withdrawal
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. |
label | string | yes | The unique identifier (ID) of the user who makes the payment. |
| account_number | string | yes | The eleven-digit account number of the customer's user in KBZpay Validation:
|
is_test | boolean | yes | The is_test parameter possible values:
|
| signature | string | yes | Signature generated with private_key. |
{
"withdrawal_id": "1234567test1234",
"payment_system": "kbzpay_manual",
"amount": 30000,
"currency_code": "MMK",
"label": "125199",
"account_number": "09444595698",
"is_test": true,
"signature": "1bfb60ae114b102fff0409804da2302f4f7fbee5"
}
{
"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 TS Paykassma).
{
"status": "fail",
"message": {
"withdrawals_sum_amount": [
"Insufficient balance"
]
}
}
Example of a withdrawal postback for a KBZpay Manual
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.
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
- Press the button "Add withdrawal request".
- Select payment system from list.
- 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 KBZpay Manual withdrawal:
- Label (user ID);
- Amount;
- Currency;
- Wallet recipient.
4. After payment the withdrawal status will change.
Paykassma does not send postback for withdrawals created manually.