Payment

  1. The user is provided with wallet details to which payment must be made.
  2. The user makes a payment in their wallet app and receives a unique transaction number.
  3. Next, the user enters a unique transaction number in the payment window, after which the transaction is activated.
  4. Paykassma sends a postback to the merchant's side.
  5. Funds are credited to the user’s balance on the merchant platform.

Payment window integration (plugin)

Example of a link to open a Ipay payment window:

https://plugin.{server_URL}/?
label=label
&currency_code=LKR
&lang=en
&wallet_type=ipay
&custom_transaction_id=custom_transaction_id
&fixed_amount=fixed_amount
&payment_url_success_id=2
&payment_url_pending_id=3
&payment_url_fail_id=1
&success_url=hash
&fail_url=hash
&pending_url=hash


wallet_type=bkash_api
currency_code=BDT
Доступные языки (lang): en, si

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/ipay?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

currencystringyes3Currency code.

label

string

yes

190

The unique identifier (ID) of the user who makes the payment.


Request
{
  "currency": "LKR",
  "label": "eligendi"
}
Response Success
{
    'status': 'ok',
    'params':  {
        'identifier': '6234234234'
    }
}
Response Fail
{
    'status': 'fail',
    'message': 'MESSAGE'
}

Activation request

URL: http://api.{server_URL}/api/v1/transaction/activate?secret={pluginapi_secret}

At this stage, the user transmits the transaction number, which you forward to the Paykassma side for activation.

Request method:
POST

Format:
JSON

Parameters:

Name

Type

Required

Max Length

Description

currency_codestringyes3LKR

wallet_type

string

yes

190

Method: Ipay.
labelstringyes190The unique identifier (ID) of the user who makes the payment.
key1stringyes190

Transaction ID received from the user (8 digits).

amountintyes256Amount of payment.
custom_transaction_id

string

yes190

Transaction ID in the Client's system. Must be unique.

Request
{
   "currency_code": "LKR",
   "label": "786442",
   "wallet_type": "ipay",
   "key1": "23936785",
   "amount": 1000,
   "custom_transaction_id": "3158538"
}
Response Success
{
    "status": "ok",
    "deposit": true,
    "deposit_amount": 100,
    "currency": {
        "code": "LKR",
        "symbol": "LKR"
    }
}
Response Pending For suspect transactions
{
    "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"
}


Response Possible Transaction Created (if the "Possible transactions" functionality is enabled")
{
    "status": "possible_transaction_created",
    "message": "Transaction not found. Possible transaction created"
}
Response Fail
{
    'status': 'fail',
    'message': 'MESSAGE'
}

Deposit postback

For the general documentation on post backs click here.

Example of deposit postback for Ipay

{
    "signature": "2ad41735cd2d225cb30fe0665e83a3ade8618e0d",
    "wallet_type": "ipay",
    "amount": 1000,
    "currency_code": "LKR",
    "label": "545932754",
    "converted_amount": {
        "USD": 3.44, "INR": 287, "EUR": 3.26, , . . . ,  "USDTTRC20": 0, "USDT20": 0
    },
    "direction": "ingoing",
    "created_datetime": "2023-09-26 19:37:02",
    "access_key": "TA25Ea9sjPUFJvIG",
    "additional_data": [
        {
            "activated_datetime": "2023-09-26 22:37:00",
            "exchanger_identifier": "923139471223",
            "comment": "",
            "amount": "1000",
            "currency_code": "LKR",
            "wallet_type": "ipay",
            "stockpiling_id": 4819603,
            "transaction_id": "23936218009",
            "transaction_type": 0,
            "plugin_custom_order_id": "5586199250",
            "withdrawal_id": null,
            "withdrawal_status": null,
            "account_number": "",
            "account_name": "",
            "account_email": "",
            "bank_details": {
                "bank_code": "",
                "branch_code": ""
            }
        }
    ]
}

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 request for Ipay

URL: https://api.{server_URL}/v2/withdrawal/create

Request method:

POST

Format:
JSON

Parameters:

Name

Type

Required

Description

withdrawal_idstringyes Withdrawal ID, if the parameter is not passed, then the system generates withdrawal _id.
payment_systemstring yesPayment system.
amount

int


required

Additional requirements:

  1. amount >= The value of the set minimum value;
  2. amount <=The value of the set maximum value.
currency_codestringyesCurrency code.

label

string

yes

The unique identifier (ID) of the user who makes the payment.

account_numberstring 

yes

User's Ipay account number.

Validation:

  • Numbers: 0-9.
  • Account number must start with "07" and contain exactly 10 digits, including the initial "07". For example: "0718448214".
bank_details.bank_codestring

yes

Here you need to pass the name of the bank, for example, "Bank of Ceylon".

bank_details.branch_codestring

yes

User's bank account number.

account_namestringyesThe name of the account holder.

is_test

booleanyes

The is_test parameter possible values:

  • true - if Withdrawal is test;
  • false - if Withdrawal is real.
signaturestringyesSignature generated with private_key.
Request
{
   "withdrawal_id": "1234567test565856",
   "payment_system": "ipay",
   "amount": 10000,
   "currency_code": "LKR",
   "label": "125199",
   "account_number": "0718448214",
   "account_name": "Test Name Acc",
   "is_test": true,
   "bank_details": {
        "bank_code": "Bank Of Ceylon"
    }, 
   "signature": "2e56786153bec935220fa1e9409ab24bd99cf9e8"
}
Response Success
{
    "status": "ok"
}


Response Fail
{
    '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).

Response Fail (if the balance is insufficient)
{
    "status": "fail",
    "message": {
        "withdrawals_sum_amount": [
            "Insufficient balance"
        ]
    }
}

Example of withdrawal postback for Ipay

{
    "signature": "c698b4961e4bfd93957c3144647f4a6704960f03",
    "wallet_type": "ipay",
    "amount": 10000,
    "currency_code": "LKR",
    "label": "125199",
    "converted_amount": {
        "USD": 30.63, "INR": 2553, "EUR": 28.07, "IDR": 472521.76, "MYR": 143.14, . . . , "USDT": 30.61996208, "USDTTRC20": 0, "USDT20": 0
    },
    "direction": "outgoing",
    "created_datetime": "2023-11-19 21:39:01",
    "access_key": "icK2pOJnH7wxSZy9jmLslGeo",
    "additional_data": [
        {
            "activated_datetime": "",
            "exchanger_identifier": "",
            "comment": "test",
            "amount": "10000",
            "currency_code": "LKR",
            "wallet_type": "ipay",
            "stockpiling_id": null,
            "transaction_id": "",
            "transaction_type": null,
            "plugin_custom_order_id": "",
            "withdrawal_id": "1234567test565856",
            "withdrawal_status": 5,
            "account_number": "03405138",
            "account_name": "Test Name Acc",
            "account_email": "",
            "bank_details": {
                "bank_code": "Bank Of Ceylon",
                "branch_code": null
            }
        }
    ]
}

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

1SUCCESSStatus for withdrawal when the withdrawal request has been successfully processed.
5FAILStatus 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 Ipay 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.