Оплата
- Пользователю предоставляются реквизиты кошелька, на которые необходимо совершить оплату.
- Пользователь совершает оплату в своем приложении кошелька и получает уникальный номер транзакции.
- Далее пользователь вводит уникальный номер транзакции в платежном окне - активируется транзакцию.
- Paykassma отсылает постбек на сторону мерчанта.
- Средства начисляются на баланс пользователя на платформе мерчанта.
Интеграция через платежное окно (plugin)
Пример ссылки на открытие платежного окна Rocket:
https://plugin.{ URL сервера }/?label=label¤cy_code=BDT&lang=lang&wallet_type=rocket&custom_transaction_id=custom_transaction_id&fixed_amount=fixed_amount&&payment_url_success_id=2&payment_url_fail_id=1 |
|---|
wallet_type=rocket currency_code=BDT Доступные языки (lang): en, bn
Обратите внимание на описание параметров 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
Создание платежа Rocket
URL: https://api.{ URL сервера }/api/v1/transaction/create/rocket?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': 'BDT',
'label': 'eligendi'
}
{
"status": "ok",
"params": {
"identifier": "01601606950"
}
}
{
'status': 'fail'
'message': 'MESSAGE'
}
Запрос активации
URL: http://api.{ URL сервера }/api/v1/transaction/activate?secret={pluginapi_secret}
На этом шаге юзер передает номер транзакции, который вы пересылаете на сторону Paykassma для активации.
Request method:
POST
Format:
JSON
Parameters:
Name | Type | Required | Max Length | Description |
| currency_code | string | yes | 3 | Код валюты |
wallet_type | string | yes | 190 | Метод |
| label | string | yes | 190 | Это уникальный идентификатор (ID) пользователя, осуществляющего платеж |
| key1 | string | yes | 190 | Transaction_ID, полученный от пользователя Rocket - 10 цифр |
| amount | float | yes | 256 | Сумма платежа |
| custom_transaction_id | string | yes | 190 | Идентификатор транзакции в системе Клиента. Должен быть уникальным. |
{
"currency_code": "BDT",
"wallet_type": "rocket",
"label": "55",
"amount": 500,
"key1": "1720943730",
"custom_transaction_id": "123465477897"
}
{
"status": "ok",
"deposit": true,
"deposit_amount": 500,
"currency": {
"code": "BDT",
"symbol": "BDT"
}
}
{
"status": "ok",
"deposit": false,
"transactions_sum": 100,
"stockpiling_sum": 100,
"lacks_sum": 300,
"minimum_deposit": 400,
"currency": {
"code": "BDT",
"symbol": "BDT"
}
}
{
"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'
}
Постбек депозита
Общую документацию по постбекам смотрите здесь.
Пример постбека на депозит bKash:
Сервер 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(1-36) | yes | Идентификатор вывода, если параметр не передается, то система генерирует withdrawal_id |
| payment_system | string | yes | Платежная система |
| amount | int | required | Дополнительные требования:
|
| currency_code | string(3) | yes | Код валюты |
is_test | boolean | yes | Параметр is_test может принимать одно из двух значений:
|
label | string(1-36) | yes | Label пользователя, для которого проводится вывод |
| account_email | string | yes | Е-mail держателя счета |
| account_number | string | yes | Номер счета получателя, 11-12 цифр, первые две - "01", example "01XXXXXXXXX" , "01XXXXXXXXXX" |
| signature | string | yes | Подпись, формируемая с private_key |
{
"withdrawal_id": "af84c26f-931d-4c28-a30d-7b75e46b7685",
"payment_system": "rocket",
"amount": 6000,
"currency_code": "BDT",
"is_test": true,
"label": "c81594cc-e4b1-4ed5-914c-3817f2ccf13a",
"account_email": "[email protected]",
"account_number": "01642234663",
"signature": "98565041a9e126d325e864da0ba3d467f6ab0566"
}
{
"status": "ok",
}
{
'status': 'fail'
'message': 'MESSAGE'
}
*Если при попытке создания заявки на вывод сумма балансов счетов в валюте заявки будет меньше, чем общая сумма новой и еще незавершенных заявок, то отобразится ошибка 'Недостаточный баланс' (для настройки данного функционала обратитесь в ТП Paykassma).
{
"status": "fail",
"message": {
"withdrawals_sum_amount": [
"Insufficient balance"
]
}
}
Пример постбека на вывод
На повторные постбеки необходимо также отвечать {"status":"ok"} код ответа 200.
После обработки вывода, Paykassma пришлет постбек о результате вывода со статусом (withdrawal_status).
Статусы выводов
| 1 | SUCCESS | Статус для вывода, когда заявка на вывод была успешно обработана |
| 5 | FAIL | Статус для вывода, когда заявка на вывод была отклонена |
Создание заявки на выплату в ЛК Paykassma
Для создания заявки на вывод, необходимо перейти на страницу Выводы (Оплаты → Выводы) и выполнить следующие шаги:
- Нажмите на кнопку "Добавить заявку на вывод".
- Выберите из списка нужную ПС.
- Заполните поля для создания заявки в следующем окне (список полей стандартизирован и не все поля являются обязательными. Для создания заявки по определенной ПС, необходимо заполнить обязательные поля для этой ПС).
Обязательные поля для выплаты Rocket:
- Лейбл (ID юзера)
- Сумма
- Валюта
- Кошелек получателя
- Email получателя
- После оплаты статус вывода поменяется
Paykassma не высылает постбек по выводам, созданным вручную.