Method is available only for withdrawals
For the general documentation on the withdrawals of funds click here.
API Creating withdrawal IMPS
URL: https://api.{server_URL}/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 possible values: true - if Withdrawal is test; |
label | string(1-36) | yes | The unique identifier (ID) of the user who makes the payment. |
| account_number | string | yes | Recipient's account number, numbers only. |
| account_name | string | yes | Account holder name. |
| bank_details.branch_code | string | yes | Bank branch code, 11 characters, ^[A-Z]{4}0[0-9A-Z]{6}$ |
| signature | string | yes | Signature generated with private_key. |
{
"withdrawal_id": "297",
"payment_system": "imps_ib",
"amount": 1218,
"currency_code": "INR",
"label": "125199",
"account_number": "123456789",
"account_name": "TestNameAcc",
"payments_details": {},
"bank_details": {
"bank_code": "IFCS0123456"
},
"is_test": true,
"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 withdrawal postback for IMPS
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:
- 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 IMPS payout:
- Label (user ID)
- Amount
- Currency code
- Account number
- Account holder name
- IFSC code
4. After payment the withdrawal status will change.
Paykassma does not send postback for withdrawals created manually.