Ввод 

Доступ к общему API реализован по белому листу IP-адресов и секретному ключу. Перед началом работы с API на ввод, необходимо передать ТП Paykassma IP-адрес с которого будут отправляться запросы.

PLUGINAPI_SECRET - строка секретного ключа. Ее необходимо будет добавлять ко всем запросам в виде get-параметра secret.
    Например: https://api.{URL_сервера_Paykassma}/api/v1/deposit-info?secret=pluginapi_secret 

При отправки запроса без использования данных параметров, будет выдаваться ошибка 404 'Не найдено'

Получение доступных ПС

https://api.{URL_server_Paykassma}/api/v1/payment-systems/available

Request method: GET

Format: JSON

Parameters:

{
    "currency_code": [ "USD", "INR" ],
    "label": "55"
}

{
  "status": "ok",
  "params": {
    "gif_guide": {
      "upi": "http:\/\/api.pay.test\/storage\/guide-image\/upi.mp4?cache=1587635151",
      "phonePe": "http:\/\/api.pay.test\/storage\/guide-image\/phonePe.gif?cache=1589958899",
      "bkash": "http:\/\/api.pay.test\/storage\/guide-image\/bkash.mpg?cache=1611553163"
    },
    "currency_data": [
      {
        "code": "INR",
        "symbol": "₹"
      }
    ],
    "wallets": [
      {
        "type": "paytm",
        "currency_code": "INR",
        "order": 5,
        "logo": "http:\/\/api.pay.test\/storage\/payment_system\/logos\/paytm_default.svg",
        "name": "PayTM"
      },
      {
        "type": "paytm",
        "currency_code": "INR",
        "order": 5,
        "logo": "http:\/\/api.pay.test\/storage\/payment_system\/logos\/paytm_34.svg",
        "name": "paytm",
        "hints": [
          {
            "type": "requisites_hint",
            "text": null
          },
          {
            "type": "payment_hint",
            "text": null
          },
          true
        ],
        "show_limits": true
      }
    ],
      "imps": {
        "INR": {
          "min": "8000",
          "max": "560000"
        }
      },
      "bkash": {
        "BDT": {
          "min": "100",
          "max": "1000000"
        }
      },
      "upi": {
        "INR": {
          "min": "20000",
          "max": "50000"
        }
      },
      "paytm": {
        "INR": {
          "min": "100000",
          "max": "20000000"
        }
      },
      "phone_pe": {
        "INR": {
          "min": "100",
          "max": "800000"
        }
      }
    }
  }
}

{
    "status": "fail"
    "message": "MESSAGE"
}

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

В данный момент существуют два типа запросов для создания платежа, в зависимости от необходимости активации платежа при проведении.

Для ПС, требующих активации платежа

1. Запрос по созданию платежа:

https://api.{{URL_server_Paykassma}/api/v1/transaction/create/{wallet_type}

Пример запроса ПС PayTM

https://api.{URL_server_Paykassma}/api/v1/transaction/create/paytm

Request method: POST

Format: JSON

Parameters:

{
    "currency": "INR",
    "label": "eligendi"
}

{
    "status": "ok",
    "params":  {
        "identifier": "6234234234"
                      }
}

{
    "status": "fail"
    "message": "MESSAGE"
}

2. Запрос для активации платежа:

https://api.{URL_server_Paykassma}/api/v1/transaction/activate

Request method: POST

Format: JSON

Parameters:

{
    "currency_code": "USD",
    "wallet_type": "paytm",
    "label": "55",
    "key1": "123-ABC-456-DEF"
    "custom_transaction_id": "123465477897"
}

{
    "status": "ok"
}

{
    "status": "fail"
    "message": "MESSAGE"
}

*Для некоторых ПС, так же в запросе необходимо передать поле amount:

Для ПС, не требующих активации платежа

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

https://api.{URL_server_Paykassma}/api/v1/payment/create/{payment_system}

Request method: POST

Format: JSON

Parameters:

{
   "language": "en",
   "currency": "USD",
   "bank": "MBB",
   "amount": "1000",
   "label": "55",
   "redirect_url": "https:\/\/google.com"
   "custom_transaction_id": "123465477897"
}

{
    "status": "ok"
}

{
    "status": "fail"
    "message": "MESSAGE"
}

Информация о накоплениях

Запрос на предоставление информации о накоплениях определенного пользователя

Для сохранения информации о транзакциях, сумма которых не превышает размер минимального депозита для конкретной платёжной системы, был реализован функционал накоплений. Транзакции пользователя (выборка по параметру label) копятся в системе и не зачисляются на счёт пользователя до тех пор, пока их сумма не достигнет минимального депозита этой платёжной системы. Постбек на сервер клиента отправится только после достижения суммы минимального депозита. До момента отправки postback транзакция не считается зачисленной на счёт. 

https://api.{URL_server_Paykassma}/api/v1/deposit-info

Request method: GET

Format: JSON

Parameters:

{
   "label": "55",
   "wallet_type": "paytm",
   "currency": "UDS"
}

{
    "status": "ok"
    "stockpiling_sum": 0,
    "lacks_sum": 0,
    "minimum_deposit": 148
}

{
    "status": "fail"
    "message": "MESSAGE"
}

< Вернуться на главную

Вывод

Актуальный тип запросов для подключения выводов:

Для вывода денежных средств пользователем через доступные для Клиента платежные системы, необходимо:

1. Единоразово передать ТП Paykassma URL-сервера, куда будут отправляться постбеки со статусом вывода.
2. Отправить запросы на вывод (POST) по URL адресу:

https://api.{URL_server_Paykassma}/v2/withdrawal/create

Request method:
POST

Format:
JSON

Каждый запрос на вывод подписывается signature, она формируется следующим образом:

ksort($data);

$implode = self::multiImplode( ':', $data);
return sha1($privateKey . md5($implode));


function multiImplode($glue, $array): string
    {
        $finArray = [];

    foreach ($array as $val) {
        $finArray[] = is_array($val) ? self::multiImplode($glue, $val) : $val;
    }

    return implode($glue, $finArray);
}

Необходимые параметры для передачи в POST запросе

Обязательные поля для ПС Bkash, PayTm, IMPS/UPI:

Request:

{
	'withdrawal_id': '1234567',
    'payment_system': 'paytm',
	'amount' : '1000',  
    'currency_code': 'INR',
	'label': '55',        
	'comment': 'withdrawal',       
	'account_number': '11111111', 
}

{
    'status': 'ok'
}

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

После обработки вывода, Paykassma пришлет постбек о результате вывода с определенным статусом, подписанной сигнатурой

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

Устаревшие запросы для вывода:

API url:

https://api.{URL_server_Paykassma}/withdrawal/manual/create

Необходимые параметры для передачи в POST запросе
Внимание: При передаче данных не должно быть пробелов в начале и конце параметров в JSON файле

Пример тела запроса:

{
    "wallet_type":"paytm",
    "wallet_recipient":"123123232",
    "wallet_sender":1111,
    "email":"[email protected]",
    "amount":1000,
    "withdrawal_id":"13",
    "signature":"fae51673a8a9c85f724317214bd0bcc665ebc799"
}

При отправки к Paykassma запроса на вывод, в первом ответе получаете сформированные данные по заявке, без сигнатуры следующего вида:

Пример данных ответа:

{
    "id":1,
    "wallet_type":"paytm",
    "wallet_recipient":"123123232",
    "wallet_sender":"1111",
    "email":"[email protected]",
    "amount":1000,
    "status":1,
    "created_at":"2020-07-08 07:06:06",
    "updated_at":"2020-07-08 09:40:39"
}

Вторым ответом уже придет постбек о результате вывода, подписанной сигнатурой.

< Вернуться на главную