Оплата
- Пользователю предоставляются реквизиты кошелька, на которые необходимо совершить оплату.
- Пользователь совершает оплату в своем приложении кошелька и получает уникальный номер транзакции.
- Далее пользователь вводит уникальный номер транзакции в платежном окне - активируется транзакция.
- Paykassma отсылает постбек на сторону мерчанта.
- Средства начисляются на баланс пользователя на платформе мерчанта.
Интеграция через платежное окно (plugin)
Пример ссылки на открытие платежного окна EasyPaisa:
https://plugin.{URL_сервера}/?label=label¤cy_code=PKR&lang=lang&wallet_type=easypaisa&custom_transaction_id=custom_transaction_id&fixed_amount=fixed_amount&payment_url_fail_id=1 |
|---|
wallet_type=easypaisa currency_code=PKR Доступные языки (lang): en, ur (Урду)
Обратите внимание на описание параметров 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/easypaisa?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': 'PKR',
'label': 'eligendi'
}
{
'status': 'ok',
'params': {
'identifier': '03432312313'
}
}
{
'status': 'fail',
'message': 'MESSAGE'
}
Запрос активации
URL: http://api.{URL_сервера}/api/v1/transaction/activate?secret={pluginapi_secret}
Request method:
POST
Format:
JSON
Parameters:
Name | Type | Required | Max Length | Description |
| currency_code | string | yes | 3 | Код валюты. |
wallet_type | string | yes | 190 | Значение из списка доступных ПС, например: easypaisa и тд. |
| label | string | yes | 190 | Это уникальный идентификатор (ID) пользователя, осуществляющего платеж. |
| key1 | string | yes | 190 | Transaction_ID, полученный от пользователя (11 цифр). |
| amount | float | yes | 256 | Сумма платежа. |
| custom_transaction_id | string | yes | 190 | Идентификатор транзакции в системе Клиента. Должен быть уникальным. |
{
"currency_code": "PKR",
"label": "786442",
"wallet_type": "easypaisa",
"key1": "23936785601",
"amount": 1200,
"custom_transaction_id": "3158538"
}
{
"status": "ok",
"deposit": true,
"deposit_amount": 6000,
"currency": {
"code": "PKR",
"symbol": "PKR"
}
}
{
"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'
}
Постбек депозита
Общую документацию по постбекам смотрите здесь.
Пример постбека на депозит EasyPaisa
На повторные постбеки необходимо также отвечать {"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 | Дополнительные требования:
|
| currency_code | string | yes | Код валюты. |
label | string | yes | Label пользователя, для которого проводится вывод. |
| account_number | string | yes | Одиннадцатизначный номер счета пользователя Клиента в easypaisa, в формате 03ХХХХХХХХХ. Валидация:
|
| account_name | string | yes | Имя держателя аккаунта (ограничение по кол-ву символов - 30, только латинский алфавит, без иных символов и цифр). Пользователю необходимо указывать имя аккаунта, привязанное к указанному номеру аккаунта. |
| bank_details.bank_code | string | yes | CNIC (national id card) - 13 цифр, номер CNIC, который юзер использовал для верификации своего кошелька EasyPaisa. Если указано неверно - выплата будет отклонена. |
is_test | boolean | yes | Параметр is_test может принимать одно из двух значений:
|
| signature | string | yes | Подпись, формируемая с private_key. |
{
"withdrawal_id": "1234567test",
"payment_system": "easypaisa",
"amount": 10000,
"currency_code": "PKR",
"label": "125199",
"account_number": "03405135211",
"account_name": "Muhammad Saqib Mushtaq",
"bank_details": {
"bank_code": "3460342887803"
},
"is_test": true,
"signature": "2e56786153bec935220fa1e9409ab24bd99cf9e8"
}
{
"status": "ok"
}
{
'status': 'fail',
'message': 'MESSAGE'
}
*Если при попытке создания заявки на вывод сумма балансов счетов в валюте заявки будет меньше, чем общая сумма новой и еще незавершенных заявок, то отобразится ошибка 'Недостаточный баланс' (для настройки данного функционала обратитесь в ТП Paykassma).
{
"status": "fail",
"message": {
"withdrawals_sum_amount": [
"Insufficient balance"
]
}
}
Пример постбека на вывод EasyPaisa
На повторные постбеки необходимо также отвечать {"status":"ok"} с кодом ответа 200.
Статусы выводов
| 1 | SUCCESS | Статус для вывода, когда заявка на вывод была успешно обработана. |
| 5 | FAIL | Статус для вывода, когда заявка на вывод была отклонена. |
Создание заявки на выплату в ЛК Paykassma
Для создания заявки на вывод, необходимо перейти на страницу Выводы (Оплаты → Выводы) и выполнить следующие шаги:
- Нажмите на кнопку "Добавить заявку на вывод".
- Выберите из списка нужную ПС.
- Заполните поля для создания заявки в следующем окне (список полей стандартизирован и не все поля являются обязательными. Для создания заявки по определенной ПС, необходимо заполнить обязательные поля для этой ПС).
Обязательные поля для выплаты EasyPaisa:
- Лейбл (ID пользователя);
- Сумма;
- Валюта;
- Кошелек получателя.
4. После оплаты статус вывода поменяется.
Paykassma не высылает постбек по выводам, созданным вручную.