You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Ввод 

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

Сохранение клиентского ID транзакции

Запрос для передачи в Paykassma вашего ID транзакции (custom_transaction_id). В дальнейшем этот ID присваивается транзакции совершаемой пользователем и передается в постбеке.

API url: https://api.{URL_сервера_Paykassma}/api/v1/payment/save-transaction-custom-id

Request method: POST

Format: JSON

Parameters:

Параметр

Тип

Обязательность

Описание

label

string (190)

ДА

Уникальный идентификатор (ID) пользователя, осуществляющего платеж

transaction_custom_id

string (190)

ДА

Идентификатор транзакции в системе Клиента

Request
{
    "label": "55",
    "transaction_custom_id": "123465477897"
}
Response Success
{
    "status": "ok"
}
Response Fail
{
    "status": "fail"
    "message": "MESSAGE"
}


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

API url: https://api.{URL_сервера_Paykassma}/api/v1/payment-systems/available

Request method: GET

Format: JSON

Parameters:

Параметр

Тип

Обязательность

Описание

currency_code

string[] (3)

ДА

Массив состоящий из кодов валют. Отобразятся ПС работающие по указанным валютам 

label

string (190)

ДА

Уникальный идентификатор (ID) пользователя, осуществляющего платеж

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


Response Success
{
    "status": "ok"
}


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

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

В данный момент существуют два вида запроса для создания платежа в зависимости от ПС.

Внимание! Для получения полного списка доступных Вам ПС, необходимо обратиться в ТП Paykassma. ТП предоставят полные примеры запросов для доступных в данный момент ПС. Они же определят правильный запрос, зависящий от выбранной ПС.

Вид запроса №1:

https://api.{URL_сервера_Paykassma}/api/v1/transaction/create/{wallet_type}

1.1 API URL: https://api.{URL_сервера_Paykassma}/api/v1/transaction/create/paytm

В данном случае сначала мы принимаем запрос на ввод по PayTM, далее в ответе мы предоставим реквизиты кошелька, на который пользователь должен перевести платеж, а после оплаты Вам необходимо отправить запрос на активацию транзакции

Request method: POST

Format: JSON

Parameters:

Параметр

Тип

Обязательность

Описание

currency

string (3)

ДА

Код валюты

label

string (190)

ДА

Уникальный идентификатор пользователя, осуществляющего платеж

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


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


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


1.2 Запрос активации:
https://api.{URL_сервера_Paykassma}/api/v1/transaction/activate

Request method: POST

Format: JSON

Parameters:

Параметр

Тип

Обязательность

Описание

currency_code

string (3)

ДА

Код валюты

wallet_type

string (190)

ДА

Значение из списка доступных ПС.
Внимание:
Для получения полного доступного списка, обратитесь в ТП Paykassma.

label

string (190)

ДА

Уникальный идентификатор пользователя, осуществляющего платеж

key1

string (190)

ДА

Код, по которому происходит активация (Transiction_ID), полученный от пользователя

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


Response Success
{
    "status": "ok"
}


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

Вид запроса №2:

https://api.{URL_сервера_Paykassma}/api/v1/payment/create/{payment_system}

2.1 API url: https://api.{URL_сервера_Paykassma}/api/v1/payment/create/{payment_system}

Request method: POST

Format: JSON

Parameters:

Параметр

Тип

Обязательность

Описание

language

string (2)

ДА

Язык интерфейса

currency

string (3)

ДА

Код валюты

bank

string (3)

ДА

Банк, через который осуществляется платеж

amount

numeric 

(ограничена max.
депозитом)

ДА

Сумма платежа

label

string (190)

ДА

Уникальный идентификатор пользователя, осуществляющего платеж

redirect_url

url 

ДА

URL страницы для редиректа после платежа

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


Response Success
{
    "status": "ok"
}


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

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

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

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

API url: https://api.{URL_сервера_Paykassma}/api/v1/deposit-info

Request method: GET

Format: JSON

Parameters:

Параметр

Тип

Обязательность

Описание

label

string (190) 

ДА

Уникальный идентификатор пользователя, осуществляющего платеж

wallet_type

url 

ДА

Значение из списка доступных ПС.
Внимание:
Для получения полного доступного списка, обратитесь в ТП Paykassma.

currency

string (3)

ДА

Код валюты

code

string (190) 
или
“null”

НЕТ

Название ручной платёжной системы.
Заполняется при
wallet_type = manual

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


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


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