Оплата

Пользователю предоставляются реквизиты кошелька, на которые необходимо совершить оплату.
Пользователь совершает оплату в своем приложении кошелька и получает уникальный номер транзакции.
Далее пользователь вводит уникальный номер транзакции в платежном окне - активирует транзакцию.
Paykassma отсылает постбек на сторону мерчанта.
Средства начисляются на баланс пользователя на платформе мерчанта.

Интеграция через платежное окно (plugin)

Пример ссылки на открытие платежного окна Bank Transfer Manual:

`https://plugin.{URL_сервера}/? label=label &currency_code=LKR &lang=lang &wallet_type=banktransfer_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=banktransfer_manual
 currency_code=LKR
Доступные языки (lang): en, si (сингальский)

Обратите внимание на описание параметров payment_url_success_id / payment_url_fail_id / payment_url_pending_id и success_url / fail_url / pending_url

Для использования payment_url_success_id / payment_url_fail_id / payment_url_pending_id необходимо передать URL'ы саппорту Paykassma, и использовать полученные ID в параметрах.

Для использования success_url / fail_url / pending_url необходимо использовать хэширование URL'ов (подробнее про хэширование см. здесь).

Описание всех параметров плагина смотрите здесь.

Интеграция через клиентский API

Создание платежа

URL: https://api.{ URL сервера }/api/v1/transaction/create/banktransfer_manual?secret={pluginapi_secret}

На данном этапе сначала мы принимаем запрос на ввод по платежной системе. Далее в ответе мы предоставим реквизиты кошелька, на который пользователь должен перевести платеж. А после оплаты Вам необходимо отправить запрос на активацию транзакции.

Request method:

POST

Format:
JSON

Parameters:

Name	Type	Required	Max Length	Description
currency	string	yes	3	Код валюты.
label	string	yes	190	Это уникальный идентификатор (ID) пользователя, осуществляющего платеж.

{
  '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'
}

Запрос активации

URL: http://api.{ 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	Код валюты (LKR).
wallet_type	string	yes	190	banktransfer_manual
label	string	yes	190	Это уникальный идентификатор (ID) пользователя, осуществляющего платеж.
key1	string	yes	20	Transaction_ID, полученный от пользователя (6-20, буквы и цифры).
screenshot	file	yes		Скриншот оплаты от пользователя.
amount	int	yes	256	Сумма платежа.
custom_transaction_id	string	yes	190	Идентификатор транзакции в системе Клиента. Должен быть уникальным.

{
    "status": "success",
    "message": "",
    "code": 20000,
    "data": [],
    "paginate": {
        "offset": 0,
        "total": 1,
        "limit": 1
    }
}

{
    'status': 'fail',
    'message': 'MESSAGE'
}

Постбек депозита

Общую документацию по постбекам смотрите здесь.

Пример постбека на депозит Bank Transfer Manual

{
  "signature": "76d0a2c6dadb2fc87d2dbdcb50809e9fb3cbc691",
  "wallet_type": "banktransfer_manual",
  "amount": 10000,
  "currency_code": "LKR",
  "label": "1234",
  "converted_amount": {
    "USD": 33.2,
    "INR": 2776,
    . . . ,
    "USDT": 33.17921909,
    "USDTTRC20": 0,
    "USDT20": 0
  },
  "direction": "ingoing",
  "created_datetime": "2024-04-18 19:20:59",
  "access_key": "UevIJHFpWVoL0ad4x6CAnQ8R",
  "additional_data": [
    {
      "activated_datetime": "2024-04-18 22:20:58",
      "exchanger_identifier": null,
      "comment": "",
      "amount": "10000",
      "currency_code": "LKR",
      "wallet_type": "banktransfer_manual",
      "stockpiling_id": 204,
      "transaction_id": "01003246080588218368",
      "transaction_type": 0,
      "plugin_custom_order_id": "test1234",
      "withdrawal_id": null,
      "withdrawal_status": null,
      "account_number": "",
      "account_name": "",
      "account_email": "",
      "bank_details": {
        "bank_code": "",
        "branch_code": ""
      }
    }
  ]
}

Сервер Paykassma ожидает ответ в json {"status":"ok"} код ответа 200, в противном случае, при получении отличающегося ответа, Paykassma будет пересылать постбек с определенной периодичностью.
На повторные постбеки необходимо также отвечать {"status":"ok"} код ответа 200.

Выводы / выплаты пользователям

Общую документацию по выводам смотрите здесь.

Создание вывода

URL: https://api.{ URL сервера }/v2/withdrawal/create

Request method:

POST

Format:
JSON

Parameters:

Name	Type	Required	Description
withdrawal_id	string	yes	Идентификатор вывода, если параметр не передается, то система генерирует withdrawal_id.
payment_system	string	yes	Платежная система.
amount	int	required	Дополнительные требования: amount >= величина установленного минимального значения; amount <= величина установленного максимального значения.
currency_code	string	yes	Код валюты.
label	string	yes	Label пользователя, для которого проводится вывод.
account_number	string	yes	Номер счета пользователя. Валидация: цифры: 0-9.
account_name	string	yes	Имя держателя счета.
bank_details.bank_code	string	yes	Банк из предоставленного списка банков.
is_test	boolean	yes	Параметр is_test может принимать одно из двух значений: true - если вывод тестовый; false - если вывод реальный.
signature	string	yes	Подпись, формируемая с private_key.

{
  "withdrawal_id": "test12345678",
  "payment_system": "banktransfer_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'
}

*Если при попытке создания заявки на вывод сумма балансов счетов в валюте заявки будет меньше, чем общая сумма новой и еще незавершенных заявок, то отобразится ошибка 'Недостаточный баланс' (для настройки данного функционала обратитесь в ТП Paykassma).

{
    "status": "fail",
    "message": {
        "withdrawals_sum_amount": [
            "Insufficient balance"
        ]
    }
}

Список актуальных банков

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

Пример постбека на вывод Bank Transfer Manual

{
  "signature": "74ead14ec43203fdd41d08cc10d96959241b4aaa",
  "wallet_type": "banktransfer_manual",
  "amount": 4000,
  "currency_code": "LKR",
  "label": "test",
  "converted_amount": {
    "USD": 13.28,
    "INR": 1110,
    "EUR": 12.48,
    ... ,
    "USDTTRC20": 0,
    "USDT20": 0
  },
  "direction": "outgoing",
  "created_datetime": "2024-04-18 19:42:01",
  "access_key": "UevIJHFpWVoL0ad4x6CAnQ8R",
  "additional_data": [
    {
      "activated_datetime": "",
      "exchanger_identifier": "",
      "comment": "",
      "amount": "4000",
      "currency_code": "LKR",
      "wallet_type": "banktransfer_manual",
      "stockpiling_id": null,
      "transaction_id": "",
      "transaction_type": null,
      "plugin_custom_order_id": "",
      "withdrawal_id": "test12345678",
      "withdrawal_status": 1,
      "account_number": "100670008622",
      "account_name": "AWAKA N V S",
      "account_email": "",
      "bank_details": {
        "bank_code": "Nations Trust Bank",
        "branch_code": null
      }
    }
  ]
}

Сервер Paykassma ожидает ответ в json {"status":"ok"} код ответа 200, в противном случае, при получении отличающегося ответа, Paykassma будет пересылать постбек с определенной периодичностью.
На повторные постбеки необходимо также отвечать {"status":"ok"} код ответа 200.

Статусы выводов

1	SUCCESS	Статус для вывода, когда заявка на вывод была успешно обработана.
5	FAIL	Статус для вывода, когда заявка на вывод была отклонена.

Создание заявки на выплату в ЛК Paykassma

Для создания заявки на вывод, необходимо перейти на страницу Выводы (Оплаты → Выводы) и выполнить следующие шаги:

Нажмите на кнопку "Добавить заявку на вывод".
Выберите из списка нужную ПС.
Заполните поля для создания заявки в следующем окне (Cписок полей стандартизирован и не все поля являются обязательными. Для создания заявки по определенной ПС, необходимо заполнить обязательные поля для этой ПС).
Обязательные поля для выплаты Bank Transfer Manual:
- Лейбл (ID пользователя);
- Сумма;
- Валюта;
- Кошелек получателя.
После оплаты статус вывода поменяется.

Paykassma не высылает постбек по выводам, созданным вручную.

Оплата

Интеграция через платежное окно (plugin)

Интеграция через клиентский API

Создание платежа

Запрос активации

Постбек депозита

Пример постбека на депозит Bank Transfer Manual

Выводы / выплаты пользователям

Создание вывода

Список актуальных банков

Пример постбека на вывод Bank Transfer Manual

Статусы выводов

Создание заявки на выплату в ЛК Paykassma

Оглавление: