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 JazzCash business payment window:
https://plugin.{server_URL}/?label=label¤cy_code=PKR&lang=en&wallet_type=jazzcash_business&custom_transaction_id=custom_transaction_id&fixed_amount=fixed_amount&payment_url_fail_id=1 |
|---|
wallet_type=jazzcash_business currency_code=PKR Available languages (lang): en, ur
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.{ URL server }/api/v1/transaction/create/jazzcash_business?secret={pluginapi_secret}
At this stage, we provide the details of the wallet to which the user must make a payment.
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": "PKR",
"label": "eligendi"
}
{
"status": "ok",
"params": {
"identifier": "00123456",
"qr_data": "0002010102112606000205520456915802PK5915Rehmani clothes6010Sillanwali530358662420211032602162990611030419910590708004809246304EF63"
}
}
{
'status': 'fail',
'message': 'MESSAGE'
}
Activation request
URL: http://api.{ URL server }/api/v1/transaction/activate?secret={pluginapi_secret}
Request method:
POST
Format:
JSON
Parameters:
Name | Type | Required | Max Length | Description |
| currency_code | string | yes | 3 | PKR |
wallet_type | string | yes | 190 | jazzcash_business |
| label | string | yes | 190 | The unique identifier (ID) of the user who makes the payment. |
| key1 | string | yes | 190 | Transaction ID received from the user (12 digits). |
| amount | float | yes | 256 | Payment amount. |
| custom_transaction_id | string | yes | 190 | The identifier of the transaction in the Client's system. Must be unique. |
{
"currency_code": "PKR",
"wallet_type": "jazzcash_business",
"label": "55",
"key1": "473811134684",
"amount": 500,
"custom_transaction_id": "123465477897"
}
{
"status": "ok",
"deposit": true,
"deposit_amount": 500,
"currency": {
"code": "PKR",
"symbol": "PKR"
}
}
{
"status": "pending",
"message": "The deposit status check has been started. The operation may take longer than expected. Upon completion of the verification, the funds will be credited to your account"
}
{
"status": "possible_transaction_created",
"message": "Transaction not found. Possible transaction created"
}
{
'status': 'fail',
'message': 'MESSAGE'
}
Deposit postback
For the general documentation on post backs click here.
Example of a deposit postback for a JazzCash business
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.{ URL server}/v2/withdrawal/create
Request method:
POST
Format:
JSON
Parameters:
Name | Type | Required | Description |
| withdrawal_id | string(1-36) | yes | Withdrawal ID, if the parameter is not passed, then the system generates withdrawal _id. |
| payment_system | string | yes | Payment system. |
| amount | int | yes | Additional requirements:
|
| currency_code | string(3) | yes | Currency code. |
is_test | boolean | yes | The is_test parameter can take one of two values:
|
label | string(1-36) | yes | The unique identifier (ID) of the user who makes the payment. |
| account_email | string | optional | Email of the account holder. |
| bank_details.bank_code | string | yes | CNIC (national id card) - 13 digits, the CNIC number that the user used to verify his JazzCash wallet. If indicated incorrectly, the payment will be rejected. |
| account_number | string | yes | Name of account holder. |
| signature | string | yes | Signature formed with private_key. |
{
"withdrawal_id": "297",
"payment_system": "jazzcash",
"amount": 1000,
"currency_code": "PKR",
"label": "125199",
"account_number": "03278516234",
"account_name": "TestNameAcc",
"payments_details": {},
"bank_details": {
"bank_code": "3460342887803"
},
"is_test": false,
"signature": "2237e83a44bba650d982edc043fc5dd39e9b816c"
}
{
"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 withdrawal postback for a JazzCash business
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 the status, signed with the 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
- 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 JazzCash business 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.