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 Upay Manual payment window:

`https://plugin.{URL_сервера}/? label=label &currency_code=LKR &lang=lang &wallet_type=upay_manual &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=upay_manual
currency_code=LKR
Available languages (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/upay_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': 'LKR',
  'label': 'eligendi'
}

{
    "status": "ok",
    "params": {
        "Account number": "066013529665120",
        "Bank name": "Seylan [Mathugama]",
        "Holder name": "K A PALITHA",
        "is_check_amount": null
    }
}

{
    '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 (LKR).
wallet_type	string	yes	190	upay_manual
label	string	yes	190	The unique identifier (ID) of the user who makes the payment.
key1	string	yes	16	Transaction ID received from the use (letters, numbers and hyphens)
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 Upay Manual

{
  "signature": "5d72de994d34e2650e4f8f032f7297f08fc46f49",
  "wallet_type": "upay_manual",
  "amount": 2000,
  "currency_code": "LKR",
  "label": "15169074",
  "converted_amount": {
    "USD": 6.45,
    "INR": 536,
    "EUR": 5.96,
   ... ,
    "USDT": 6.45297326,
    "USDTTRC20": 0,
    "USDT20": 0
  },
  "direction": "ingoing",
  "created_datetime": "2024-02-29 14:19:15",
  "access_key": "XxdZIDCzwGYvQa28jfTunHekU",
  "additional_data": [
    {
      "activated_datetime": "2024-02-29 17:19:12",
      "exchanger_identifier": null,
      "comment": "",
      "amount": "2000",
      "currency_code": "LKR",
      "wallet_type": "upay_manual",
      "stockpiling_id": 3454,
      "transaction_id": "B3A240229-009236",
      "transaction_type": 0,
      "plugin_custom_order_id": "30569060",
      "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

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: amount >= The value of the set minimum value; amount <= The value of the set maximumvalue.
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 user's bank account number. Validation: Digits: 0-9.
account_name	string	yes	Name of account holder.
bank_details.bank_code	string	yes	The bank from the provided list of banks.
is_test	boolean	yes	The is_test parameter possible values: true - if Withdrawal is test; false - if Withdrawal is real.
signature	string	yes	Signature generated with private_key.

{
  "withdrawal_id": "test12345678",
  "payment_system": "upay_manual",
  "amount": 4000,
  "currency_code": "LKR",
  "label": "test",
  "account_number": "100670008622",
  "account_name": "AWAKA N V S",
  "bank_details": {
    "bank_code": "Nations Trust Bank"
  },
  "signature": "83722f5c8c963d7f7a6e5bbe0d1f13a4761927c4"
}

{
    "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"
        ]
    }
}

List of current banks

Amana Bank
Asia Asset Finance PLC
Bank of Ceylon
Bimputh Finance PLC
Cargills Bank
CDB
Central Finance
Citibank
CLC
Commercial Bank of Ceylon PLC
Commercial Bank PLC
Deutsche Bank AG
DFCC Bank
Dialog Finance PLC
Fintrex Finance Limited
Habib Bank Limited
Hatton National Bank PLC
HDFC Bank
HSBC
Indian Bank
Indian Overseas Bank
LB Finance
LOFC
LOLC Development Finance PLC
MCB Bank Limited
Merchant Bank of Sri Lanka & Finance PLC
Nations Trust Bank PLC
NDB Bank
HNB Finance Limited
NSB
National Savings Bank
PABC
People's Bank
Peoples Bank
People’s Leasing and Finance PLC
Public Bank Berhad
Regional Development Bank
Sampath Bank PLC
State Bank of India
SDB Bank (Sanasa)
Senkadagala Finance
Seylan Bank
Standard Chartered Bank
Singer Finance
Union Bank of Colombo PLC

Example of a withdrawal postback for a Upay Manual

{
  "signature": "2f9be236d3299256360a928831d92f6cf36871b2",
  "wallet_type": "upay_manual",
  "amount": 3600,
  "currency_code": "LKR",
  "label": "14929202",
  "converted_amount": {
    "USD": 11.62,
    "INR": 964,
    "EUR": 10.72,
    "IDR": 182716.03,
    . . . ,
    "WAVES": 4.31911999,
    "USDT": 11.62119326,
    "USDTTRC20": 0,
    "USDT20": 0
  },
  "direction": "outgoing",
  "created_datetime": "2024-02-29 11:01:02",
  "access_key": "XxdZIDCzwGYvQa28jfTunHekU",
  "additional_data": [
    {
      "activated_datetime": "",
      "exchanger_identifier": "",
      "comment": "",
      "amount": "3600",
      "currency_code": "LKR",
      "wallet_type": "upay_manual",
      "stockpiling_id": null,
      "transaction_id": "",
      "transaction_type": null,
      "plugin_custom_order_id": "",
      "withdrawal_id": "29599588",
      "withdrawal_status": 1,
      "account_number": "117854929954",
      "account_name": "WNKPerera",
      "account_email": "",
      "bank_details": {
        "bank_code": "Sampath Bank PLC",
        "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.

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.