Ввод
Внимание!
Данный способ интеграции является НЕ рекомендуемым, если Вы ранее не интегрировали похожие платежные решения, требующие активации. Рекомендуемый способ интеграции.
При выборе интеграции по API, мы рекомендуем дополнительно провести следующие доработки:
- Добавить под каждую ПС подсказки в текстовом виде для пояснения пользователю всех шагов оплаты.
- Добавить визуальное пояснение процесса оплаты - gif-ки с отображением процесса и скриншоты шагов оплаты.
- Скриншоты и всю необходимую минимально текстовую информацию можно получить напрямую от ТП Paykassma.
Доступ к общему API реализован по секретному ключу. 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 | string[] (3) | ДА | Массив состоящий из кодов валют. Отобразятся ПС работающие по указанным валютам |
label | string (190) | ДА | Уникальный идентификатор (ID) пользователя, осуществляющего платеж |
{
"currency_code": [ "USD", "INR" ],
"label": "55"
}
{
"status": "ok"
"params": {
"currency_data": [
{
"code": "USD",
"symbol": "$"
},
{
"code": "INR",
"symbol": "INR"
}
],
"wallets": [
{
"type": "staging_b_ml",
"currency_code": "INR",
"order": 6,
"logo": "https://api.staging.client-paykassma.com/storage/payment_system/logos/staging_b_ml.png",
"name": "staging B ml",
"is_manual": true,
"uploading_payment_bill": true
},
{
"type": "nagad",
"currency_code": "USD",
"order": 17,
"logo": "https://api.staging.client-paykassma.com/storage/payment_system/logos/nagad_default.svg",
"name": "Nagad",
"is_manual": false,
"uploading_payment_bill": false
}
]
}
}
{
"status": "fail"
"message": "MESSAGE"
}
Получение медиаподсказок
Для получения медиаподсказок о том, как совершить депозит по платежной системе, необходимо отправить запрос:
https://api.{URL_server_Paykassma}/wallet-type/images/
Request method: GET
Format: JSON
{
"status": "fail"
"message": "MESSAGE"
}
Создание платежа
В данный момент существуют два типа запросов для создания платежа, в зависимости от необходимости активации платежа при проведении.
Внимание! Для получения полного списка ПС, для которых необходима активация, обратитесь в ТП Paykassma. ТП предоставят полные примеры запросов для доступных в данный момент ПС.
Для ПС, требующих активации платежа
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 | string (3) | ДА | Код валюты |
label | string (190) | ДА | Уникальный идентификатор пользователя, осуществляющего платеж |
{
"currency": "INR",
"label": "eligendi"
}
{
"status": "ok",
"params": {
"identifier": "6234234234"
}
}
{
"status": "fail"
"message": "MESSAGE"
}
2. Запрос для активации платежа
В зависимости от значения параметра is_manual, различают два типа запросов для активации платежей:
1) если is_manual = false
https://api.{URL_server_Paykassma}/api/v1/transaction/activate
Request method: POST
Format: JSON
Parameters:
Параметр | Тип | Обязательность | Описание |
currency_code | string (3) | ДА | Код валюты |
wallet_type | string (190) | ДА | Значение из списка доступных ПС |
label | string (190) | ДА | Уникальный идентификатор пользователя, осуществляющего платеж |
key1 | string (190) | ДА | Код, по которому происходит активация (Transaction_ID), полученный от пользователя |
| amount | float | *required if | Сумма транзакции |
custom_transaction_id | string (64) | ДА | Уникальный идентификатор транзакции в системе Клиента Необходимо передавать неповторяющееся значение параметра |
{
"currency_code": "USD",
"wallet_type": "paytm",
"label": "55",
"key1": "123-ABC-456-DEF"
"custom_transaction_id": "123465477897"
}
{
"status": "ok"
}
{
"status": "fail"
"message": "MESSAGE"
}
2) если is_manual = true
https://api.{URL_server_Paykassma}/api/v1/possible-transaction
Request method: POST
Format: JSON
Parameters:
| Name | Type | Required | Description |
| secret | string | yes | Ключ доступа |
Body:
Параметр | Тип | Обязательность | Описание |
currency_code | string (3) | ДА | Код валюты |
wallet_type | string (190) | ДА | Значение из списка доступных ПС. |
label | string (190) | ДА | Уникальный идентификатор пользователя, осуществляющего платеж |
key1 | string (190) | ДА | Код, по которому происходит активация (Transaction_ID), полученный от пользователя |
| amount | float | ДА | Сумма транзакции |
| screenshot | string (190) | НЕТ | Загрузка скриншота об оплате |
custom_id | string (190) | ДА | Идентификатор транзакции в системе Клиента |
{
"status": "success",
"message": "",
"code": 20000,
"data": [],
"paginate": {
"offset": 0,
"total": 1,
"limit": 1
}
}
{
"status": "fail",
"message": {
"key1": [
"Transaction field has wrong length"
]
}
}
*При включенном функционале Отложенная автоматическая активация транзакций(Возможные транзакции)
{
"status": "possible_transaction_created",
"message": "Transaction not found. Possible transaction created"
}
**Для некоторых ПС, так же в запросе необходимо передать поле amount:
| Платежная система | currency_code | wallet_type | label | key1 | amount | custom_transaction_id |
|---|---|---|---|---|---|---|
| UPI P2P | required | required | required | required | required | required |
| PhonePe | required | required | required | required | required | required |
| bKash | required | required | required | required | - | required |
| Nagad | required | required | required | required | - | required |
***При попытке активировать подозрительную транзакцию будет отображаться ошибка 400 'Запущена проверка статуса депозита. Операция может занять больше времени, чем ожидалось. По завершении проверки денежные средства будут зачислены на ваш счет'.
Для ПС, не требующих активации платежа
Создание платежа:
https://api.{URL_server_Paykassma}/api/v1/payment/create/{payment_system}
Request method: POST
Format: JSON
Parameters:
Параметр | Тип | Обязательность | Описание |
language | string (2) | ДА | Язык интерфейса |
currency | string (3) | ДА | Код валюты |
bank | string (3) | ДА | Банк, через который осуществляется платеж |
amount | float (ограничена max. | ДА | Сумма платежа |
label | string (190) | ДА | Уникальный идентификатор пользователя, осуществляющего платеж |
redirect_url | url | ДА | URL страницы для редиректа после платежа |
custom_transaction_id | string (64) | ДА | Уникальный идентификатор транзакции в системе Клиента Необходимо передавать неповторяющееся значение параметра |
{
"language": "en",
"currency": "USD",
"bank": "MBB",
"amount": 1000.00,
"label": "55",
"redirect_url": "https:\/\/google.com"
"custom_transaction_id": "123465477897"
}
{
"status": "ok"
}
{
"status": "fail"
"message": "MESSAGE"
}
Возможные статусы ответа
| Код состояния | Текст ошибки |
|---|---|
| 400 | Unknown upi payment mode. |
| 404 | Payment method is not supported. |
| 405 | Payment acceptance for this system is suspended. |
| 424 | Payment method is currently unavailable. |
Пример запроса ПС Bkash API
http://api.{ URL_server_Paykassma }/api/v1/payment/create/bkash_api
Request method: POST
Format: JSON
Params:
| Name | Type | Required | Description |
| secret | string | yes | Ключ доступа |
Body:
Параметр | Тип | Обязательность | Описание |
amount | float (ограничена min и max. депозитом) | ДА | Сумма платежа |
| account_number | string (11) | ДА | Одиннадцатизначный номер счета пользователя Клиента в Bkash, в формате 01ХХХХХХХХХ Валидация:
|
| currency | string (3) | ДА | Код валюты |
| label | string (190) | ДА | Это уникальный идентификатор (ID) пользователя, осуществляющего платеж |
| custom_transaction_id | string (64) | ДА | Уникальный идентификатор транзакции в системе Клиента Необходимо передавать неповторяющееся значение параметра |
| success_url | string (не ограничен) | ДА | Ссылка, на которую нужно перенаправить пользователя со страницы Bkash в случае успешной оплаты. |
| failure_url | string (не ограничен) | ДА | Ссылка, на которую нужно перенаправить пользователя со страницы Bkash в случае ошибки оплаты. |
| cancel_url | string (не ограничен) | ДА | Ссылка, на которую нужно перенаправить пользователя со страницы Bkash в случае отмены оплаты. |
{
"amount": 1.00,
"account_number": "01770618575",
"currency": "BDT",
"label": "test",
"custom_transaction_id": "01abc0095689",
"success_url": "https://static5.depositphotos.com/1029663/395/i/600/depositphotos_3955476-stock-photo-green-check-mark.jpg?status=success",
"failure_url": "https://top-fon.com/uploads/posts/2021-07/1626870875_29-p-krasnii-krest-fon-32.png?status=failure",
"cancel_url": "https://yandex.ru/"
}
{
"status": "ok",
"data": {
"orderId": "1cb4627a420a6e69",
"bkashUrl": "https://sandbox.payment.bkash.com/redirect/tokenized/?paymentID=TR00114E1661778153815&hash=dcRq9geuCtjkN6rFpaGxdLAMrmyxIxL*kEN-p41SLL2M!xXy9m2OTUTLwlAGMVWDKyE8xkOHj_N_AHaTxNGT*(V2LXyC5y4zpUsG1661778154005&mode=0011&apiVersion=v1.2.0-beta",
"message": "Successful"
}
}
{
'status': 'fail'
'message': 'MESSAGE'
}
Пример запроса ПС Nagad API
http://api.{ URL_server_Paykassma }/api/v1/payment/create/nagad_api
Request method: POST
Format: JSON
Params:
| Name | Type | Required | Description |
| secret | string | yes | Ключ доступа |
Body:
Параметр | Тип | Обязательность | Описание |
amount | float (ограничена min и max. | ДА | Сумма платежа |
| currency | string (3) | ДА | Код валюты |
| label | string (190) | ДА | Это уникальный идентификатор пользователя, осуществляющего платеж |
| custom_transaction_id | string (64) | ДА | Уникальный идентификатор транзакции в системе Клиента Необходимо передавать неповторяющееся значение параметра |
| success_url | string (не ограничен) | ДА | Ссылка, по которой нужно перенаправить пользователя со страницы Nagad в случае успешной оплаты. |
| fail_url | string (не ограничен) | ДА | Ссылка, по которой нужно перенаправить пользователя со страницы Nagad в случае ошибки оплаты |
| cancel_url | string (не ограничен) | ДА | Ссылка, по которой нужно перенаправить пользователя со страницы Nagad в случае отмены оплаты. |
{
"custom_transaction_id": "custom_transaction_1",
"amount": 100.00,
"currency": "BDT",
"label": "test_user",
"success_url": "https://success_url.com",
"fail_url": "https://fail_url.com",
"cancel_url": "https://cancel_url.com"
}
{
"status": "ok",
"payment_url": "callBackUrl"//ссылка на страницу оплаты Nagad, на которой пользователь должен ввести все необходимые реквизиты и совершить оплату.
}
{
'status': 'fail'
'message': 'MESSAGE'
}
Информация о накоплениях
Для сохранения информации о транзакциях, сумма которых не превышает размер минимального депозита для конкретной платёжной системы, был реализован функционал накоплений. Транзакции пользователя (выборка по параметру label) копятся в системе и не зачисляются на счёт пользователя до тех пор, пока их сумма не достигнет минимального депозита этой платёжной системы. Постбек на сервер клиента отправится только после достижения суммы минимального депозита. До момента отправки postback транзакция не считается зачисленной на счёт.
В постбеке ввода, можно увидеть поле Stockpiling, в нем указана сконвертированная во все валюты сумма транзакций, участвующих в накоплении (одна и более транзакции). Конвертация осуществляется на основе открытых данных о курсах валют. Все валюты передаются с точностью до сотых долей, криптовалюты имеют 8 знаков в дробной части (стомиллионная точность). Так же в поле transactions передается информация о совершённых транзакциях, участвующих в накоплении (одна и более). Передается в виде массива.
Запрос на предоставление информации о накоплениях определенного пользователя
https://api.{URL_server_Paykassma}/api/v1/deposit-info
Request method: GET
Format: JSON
Parameters:
Параметр | Тип | Обязательность | Описание |
label | string (190) | ДА | Уникальный идентификатор пользователя, осуществляющего платеж |
wallet_type | url | ДА | Значение из списка доступных ПС. |
currency | string (3) | ДА | Код валюты |
code | string (190) | НЕТ | Название ручной платёжной системы. |
{
"label": "55",
"wallet_type": "paytm",
"currency": "UDS"
}
{
"status": "ok"
"stockpiling_sum": 0,
"lacks_sum": 0,
"minimum_deposit": 148
}
{
"status": "fail"
"message": "MESSAGE"
}
Хеширование адресов для редиректа
В коде виджета заданы параметры для указания адресов для редиректа. Указывать адреса необходимо в хешированном виде. Для хеширования адресов необходимо отправить следующий запрос (
доступ реализован по ключу secret):
https://api.{URL_server_Paykassma}/payment-plugin/hash-url?secret=pluginapi_secret
Request method: POST
Format: JSON
Parameters:
Параметр | Тип | Обязательность | Описание | |
| success_urls | array | ДА | Список адресов для редиректа при успешной оплате. | |
| order | integer | *ДА | Номер адреса для редиректа в списке. | |
| url | string | *ДА | Адрес для редиректа пользователя при успешной оплате. | |
| fail_urls | array | ДА | Список адресов для редиректа при неуспешной оплате. | |
| order | integer | *ДА | Номер адреса для редиректа в списке. | |
| url | string | *ДА | Адрес для редиректа пользователя при неуспешной оплате. | |
| pending_urls | array | ДА | Список адресов для редиректа при ожидании подтверждения оплаты. | |
| order | integer | Если указано одно из свойств, то второе обязательно | Номер адреса для редиректа в списке. | |
| url | string | Адрес для редиректа при ожидании подтверждения оплаты. | ||
*Один из массивов success_urls или fail_urls может быть пустым.
Внимание!
Время жизни хеша - 1 день. По истечении срока при необходимости запросить хеш для адреса повторно.
Вывод
Актуальный тип запросов для подключения выводов:
Для вывода денежных средств пользователем через доступные для Клиента платежные системы, необходимо:
- Единоразово передать ТП Paykassma URL-сервера, куда будут отправляться постбеки со статусом вывода.
- Отправить запросы на вывод (POST) по URL адресу, без использования "secret=pluginapi_secret " :
https://api.{URL_server_Paykassma}/v2/withdrawal/create
Request method:
POST
Format:
JSON
Каждый запрос на вывод подписывается signature, она формируется следующим образом:
Алгоритм формирования signature
- Инициализируется свой приватный ключ.
- Формируется массив с данными, которые будут захэшированы. Массив может быть многомерным.
- Элементы массива сортируются по ключу при помощи функции ksort()
- Элементы массива рекурсивно конкатенируются друг с другом через строку ":".
- Далее выделяется md5 hash полученной строки.
- Конкатенируется приватный ключ с hash строкой.
- Далее выделяется sha1 hash с полученной строки.
Пример формирования signature на php
$data = [
...
];
$data['signature'] = generateSignature($data); // return fa0ee1e2acf7f898635ec417491381c0a4f9d35c
//send $data like json ...
function generateSignature(array $data) {
$privateKey = 'yourprivatekey';
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 запросе
Наименование | Тип | Обязательность | Описание |
| withdrawal_id | string(1-36) | optional | Идентификатор вывода, если параметр не передается, то система генерирует withdrawal_id |
| payment_system | string | required | Платежная система |
| amount | int | required | Дополнительные требования:
Кратность: Для ПС PayTM: amount кратно "10". |
| currency_code | string(3) | required | Код валюты |
| label | string | required | Label пользователя, для которого проводится вывод |
is_test | boolean | required | Параметр is_test может принимать одно из двух значений:
|
| account_number | string | *required_if | Номер счета получателя Маска ввода: Для ПС PayTM: Цифры(10) (без международного кода +91) Для ПС UPI IB / IMPS IB: Цифры Для ПС Bkash / Nagad: Цифры(11) в формате 01xxxxxxxxx Для ПС Rocket: Цифры(11-12) в формате 01xxxxxxxxxх |
| account_name | string | *required_if ПС = imps_ib, upi_ib,.... | Имя держателя счета |
| account_email | string | *required_if ПС = bkash,... | Е-mail держателя счета |
| payments_details.payments_method | string | *required_if | Способ оплаты |
| payments_details.payments_provider | string | optional | Поставщик, который осуществляет электронный платеж, выбранным способом оплаты |
| bank_details.bank_code | string(11) | *required_if | Уникальный идентификатор присваиваемый центральным банком страны Маска ввода: Для ПС IMPS IB: IFSC code - длина должна составлять 11 символов, содержать буквы и цифры без пробела и тире. Подробнее: https://en.wikipedia.org/wiki/Indian_Financial_System_Code |
| bank_details.branch_code | string | *required_if | Код филиала (отделения) банка |
| bank_details.bank_code_in_payments_system | string | *required_if | Код банка в платежной системе, с которой осуществляется обмен данными |
| account_type | string | *required_if | Тип аккаунта |
| document_type | string | *required_if | Тип документа |
| document_id | string | *required_if | Идентификатор документа получателя |
| account_digit | string | *required_if | Цифра счета |
| iban | string | *required_if | IBAN |
Обязательные поля для ПС Bkash, PayTm, IMPS IB/UPI IB:
| Платежная система | account_number | account_name | account_email | payments_details | bank_details | |||
|---|---|---|---|---|---|---|---|---|
| payments_method | payments_provider | bank_code | branch_code | bank_code_in_payment_system | ||||
Bkash | required | - | required | - | - | - | - | - |
| IMPS IB | required | required | - | - | - | required | - | - |
| Paytm | required | - | - | - | - | - | - | - |
Request:
{
"withdrawal_id": "1234567",
"payment_system": "paytm",
"amount" : 1000,
"currency_code": "INR",
"label": "55",
"is_test": false,
"comment: "withdrawal",
"account_number": "11111111",
"payments_details": {
"payments_provider": "56",
"payments_method": "MOBILE_MONEY"
},
"bank_details": {
"bank_code": "MAHB0001821",
"branch_code": "000254",
"bank_code_in_payments_system": "9393"
},
"signature":"fae51673a8a9c85f724317214bd0bcc665ebc799"
}
{
"status": "ok"
}
{
"status": "fail"
"message": "MESSAGE"
}
*Если при попытке создания заявки на вывод сумма балансов счетов в валюте заявки будет меньше, чем общая сумма новой и еще незавершенных заявок, то отобразится ошибка 'Недостаточный баланс' (для настройки данного функционала обратитесь в ТП Paykassma).
{
"status": "fail",
"message": {
"withdrawals_sum_amount": [
"Insufficient balance"
]
}
}
После обработки вывода, Paykassma пришлет постбек о результате вывода с определенным статусом, подписанной сигнатурой
Статусы выводов
| Статус | Описание |
|---|---|
| PROCESSED (1) | Статус для вывода, когда заявка на вывод была успешно обработана |
| REJECTED (5) | Статус для вывода, когда заявка на вывод была отклонена |
Информация о ранее отправленном постбеке
Запрос на предоставление информации о ранее успешно отправленном постбеке.
PLUGINAPI_SECRET - строка секретного ключа. Ее необходимо будет добавлять ко всем запросам в виде get-параметра secret.
Например: https://api.{URL_сервера_Paykassma}/api/v1/postback?secret=pluginapi_secret
https://api.{URL_server_Paykassma}/api/v1/postback
Request method: GET
Format: JSON
Parameters:
Параметр | Тип | Обязательность | Описание |
type | string | ДА | Тип постбека. Возможные значения:
|
transaction_id | string | Обязателен хотя бы один из параметров, если type = deposit | Номер транзакции |
| custom_id | string | Номер заказа Если в Paykassma содержится несколько транзакций с одинаковым номером заказа, будет отобрана только одна из них. Поэтому уникальность custom_id необходимо контролировать на стороне системы Клиента. | |
| withdrawal_id | string | Обязателен, если type = withdrawal | ID вывода |
Баланс счетов
Запрос на предоставление информации о балансе счетов Клиента (кроме баланса Сеттлемента) формируется следующим образом:
https://api.{URL_server_Paykassma}/api/v1/accounts-balance?secret={{pluginapi.secret}}
Request method: GET
Format: JSON
Parameters:
| Name | Type | Required | Description |
| secret | string | yes | Ключ доступа |
{
"status": "success",
"message": "",
"code": 20000,
"data": {
"balances": [
{
"wallet_type": "paytm",
"currency_code": "IDR",
"amount": -324324.00
},
{
"wallet_type": "paytm",
"currency_code": "USD",
"amount": -10800.00
},
{
"wallet_type": "bkash",
"currency_code": "VND",
"amount": 155.00
},
{
"wallet_type": "bkash",
"currency_code": "BRL",
"amount": 187239.195
},
{
"wallet_type": "bkash",
"currency_code": "EUR",
"amount": 23.9375
},
{
"wallet_type": "nagad",
"currency_code": "CUC",
"amount": 471.00
},
{
"wallet_type": "upi_ib",
"currency_code": "SAR",
"amount": 499.00
}
]
}
{
"status": "error",
"code": 30228,
"errors": {
"target": "secret",
"code": 36205,
"message": "Wrong secret"
},
"error_message": "Data validation error"
}
Статусы заказов
Запрос на предоставление информации о статусах заказов Клиента формируется следующим образом:
https://api.{URL_server_Paykassma}/api/v1/pullpostbacks?secret={{pluginapi.secret}}
Request method: GET
Format: JSON
Parameters:
| Наименование | Тип | Обязательность | Описание |
| secret | string | YES | Ключ доступа |
Наименование | Тип | Обязательность | Описание |
|---|---|---|---|
| type | string | ДА | Возможные значения:
|
| plugin_custom_order_id | array | ДА, если type deposit | ID транзакции пользователя/номер заказа |
| withdrawal_id | array | ДА, если type withdrawal | ID вывода |
Response body:
| Наименование | Тип | Обязательность | Описание | |||||
|---|---|---|---|---|---|---|---|---|
status | string | ДА | Статус запроса | |||||
| massage | string | Заполняется в случае успешного ответа | Сообщение при успешном ответе | |||||
| code | int | ДА | Код ответа | |||||
| data | array/object | Заполняется в случае успешного ответа | ||||||
| transactions | array | ДА, если type deposit | Информация о депозите | |||||
| plugin_custom_order_id | string | ДА | ID транзакции пользователя/номер заказа | |||||
message | string | ДА, если транзакция не найдена | Сообщение, если транзакция не была найдена | |||||
| postback | array | ДА, если транзакция найдена | Информация о постбеке | |||||
| withdrawals | array | ДА, если type withdrawal | Информация о выводе | |||||
| withdrawal_id | string | ДА | ID вывода | |||||
| message | string | ДА, если вывод не найден | Сообщение, если транзакция не была найдена | |||||
| postback | array | ДА, если вывод не найден | Информация о постбеке | |||||