API Общее - информация по аккаунту, выписка, контроль платежей, валюты, курсы

Данный интерфейс предназначен для получения следующих данных:

  • Доступные способы оплаты для конкретного магазина, подключенного к onlineMerchant или upBalance;
  • Курсы конвертации валют;
  • Выписка по операциям за произвольный период;
  • Статус операции;
  • Баланс Клиента в системе PAYSTO.
ВАЖНО! Любые работы по подключению приема платежей на Вашем сайте могут быть выполнены только специалистами с соответствующими знаниями в области программирования. Проведение работ на сайте без соответствующей подготовки могут вызвать нарушения работы Вашего сайта или веб-системы, полную или частичную потерю любых данных. Перед началом проведения работ рекомендуется выполнить архивацию (back-up) всех данных Вашего сайта/веб-системы, включая данные исполняемых файлов/скриптов. Любые работы с Вашим сайтом Вы производите на собственный страх и риск. Paysto не несет ответственность за любые повреждения или нарушения в работе Вашего сайта, а также утрату данных. Техническая поддержка по работе интерфейсов Paysto может быть оказана только в части взаимодействия на стороне Paysto.

Оглавление

  1. Введение
    1. Назначение
    2. Описание
    3. Термины и понятия
  2. Типы передаваемых данных
  3. Обеспечение безопасности
    1. Запросы
    2. Ответы Paysto
    3. Адреса отвечающих серверов
  4. Сведения о платежах
    1. Выписка за период
  5. Состояние счета
    1. Доступный баланс (доступно для вывода)
    2. Ожидаемый баланс (все поступившие платежи зачислены; все блокировки сняты)
    3. Поступившие средства, всего
  6. Настройки тарифа
    1. Список валют доступных для оплаты
    2. Список курсов
  7. Аппендикс
    1. Данные получаемые из интерфейса Клиентского Кабинета
    2. Примеры использования

1. Введение    

1.1. Назначение

Предназначен для различных проектов, в которых требуется проверка текущего баланса Клиента, контроль статуса операции, а также для реализации выбора способа оплаты на стороне клиента (проекта, магазина).

 

1.2. Описание

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

  • Доступные способы оплаты для магазина, подключенного к onlineMerchant или upBalance;
  • Курсы конвертации валют;
  • Выписка по операциям;
  • Статус операции;
  • Баланс Клиента с учетом сроков зачисления, блокировки средств и т.п..

1.3. Термины и понятия

Термин Описание
Магазин или Проект Информационная система Получателя. Например, корзина Плательщика на сайте Получателя и система биллинга Получателя.
Валюта Средство оплаты (например банковский платеж, WMR, WMZ и т.д.)

 

2. Типы передаваемых данных    

Название Описание Диапазон значений
Целое Целое От 0 до 2147483647
Длинное целое Длинное целое От 0 до 4294967296
Денежное Вещественное, разделитель целой и дробной части «.» (точка), разделителя разрядов нет, дробная часть с точностью до сотых. Наличие точки и двух цифр после нее – обязательно. Например, 10 должно быть записано как 10.00, 10.123 должно быть записано как 11.12 или 11.13 от 0.01 до 1000000.00
Строка Строка. Не может содержать символ «=» (равно) и символ «&» (амперсанд). Для каждого параметра длина строки определяется отдельно.
Дата время Всемирное координированное время (UTC). Представлено в формате yyyymmddhhnn где y – цифры для обозначения года, m – месяца, d – дня месяца, h – часа (hh – число от 0 до 23) n – минут. Например, 15 января 2010 17:04 201001151704 От 201001010000 до 205012312359
Булевский 0 – нет, 1 - да 0 или 1
MD5

Строка, представляющая собой 32-разрядное число в 16-ричной форме и в верхнем регистре (всего 32 символа 0-9, A-F).  
Алгоритм создания подписи данных.

  1. Пары Название-Значение всех параметров запроса (кроме PAYSTO_MD5) сортируются по Названию в алфавитном прямом порядке.
  2. Название-Значения склеиваются в строку «Название=Значение&», полученные строки склеиваются в порядке установленном в п1.
  3. В конец полученной строки приклеивается значение секретного ключа (указывается при регистрации магазина). Например, должно получиться «Название1=Значение1& Название2=Значение2&СекретныйКлюч»
  4. Если в кабинете включен «Режим совместимости md5», то из полученной строки удаляются все символы, зависящие от кодировок, т.е. удовлетворяющие регулярному выражению, указанному на странице настройки магазина.
  5. Вычисляется MD5 полученной в п3 строки в UTF8.
  6. Результат из п4 записывается строкой и переводится в верхний регистр.
 
Статус заявки

Код статуса заявки. Возможные значения:

  • RES_BILLED – заявка отправлена на оплату;
  • RES_CANCEL - покупатель отказался от покупки;
  • RES_CREATED – заявка зарегистрирована;
  • RES_ERROR - при платеже произошли ошибки;
  • RES_HOLD - заявка приостановлена;
  • RES_PAID - оплата состоялась.
Смотри колонку «Описание».

 

 

3. Обеспечение безопасности    

 

3.1. Запросы

  1. Проверяется IP источника запроса (onlineMerchant проверяет опционально, если IP ИС указан в настройках кабинета).
  2. Подпись MD5 (обязательно).
  3. Счетчик запроса, делает невозможным получить ответ с данными при повторе запроса без увеличения номера и пересчета подписи (опционально, если указан). Настоятельно рекомендуется для запросов, где остальные параметры не меняются (например, при запросе баланса).

3.2. Ответы Paysto

Проверяйте SSL сертификат ответившего сервера.

3.3. Адреса отвечающих серверов

IP-адрес сервера
23.102.21.72
137.135.207.41
23.102.17.162

 

4. Сведения о платежах    

Внимание! При данных запросах рекомендуется проверять SSL сертификат ответившего сервера для предотвращения DNS подлогов.

 

4.1. Выписка за период

Элемент адреса Значение
Протокол https | http
Метод Get
Путь https://paysto.com/api/Payment/GetList

Параметры

Название Описание Тип Обязательный
FROM начало периода (по умолчанию – начало текущих суток). Дата время Да
TO конец периода (по умолчанию – текущий момент). Дата время Да
PAYSTO_SHOP_ID Id магазина целое Да
PAYSTO_REQUEST_NO Сквозной (общий для всех типов запросов) счетчик запросов ИС, каждое последующее значение должно быть больше предыдущего. Длинное целое Нет
PAYSTO_MD5 Подпись передаваемых данных. Контрольная сумма MD5. MD5 Да

Ответы

Ответ Формат
HTTP CODE 200 CSV файл в виде Datetime,PAYSTO_PAYMENT_ID,PAYSTO_INVOICE_ID,PAYSTO_SUM,accountSum,status, statusNote,currencyName,PAYSTO_TEST Если за указанный период не было платежей – пустой файл
HTTP CODE 403 Нарушены условия безопасности. Проверьте передаваемые параметры и настройки.
HTTP CODE 404 Не найден магазин

Описание столбцов

Название Описание Тип
Datetime Дата и время регистрации заявки. Дата время
PAYSTO_PAYMENT_ID Номер транзакции в PaySto Длинное целое
PAYSTO_INVOICE_ID Переданный номер счета в магазине. Строка до 50 символов
PAYSTO_SUM Сумма заявки (сумма которую фактически собирались оплатить/уже оплатили) Денежный
accountSum Движение по Счету Клиента. Положительное – увеличение баланса, отрицательное – уменьшение баланса. Денежный
status Код статуса заявки. Статус заявки
statusNote Комментарий к статусу. Например, если статус RES_ERROR – то описание ошибки. Строка
currencyName Валюта платежа Строка
PAYSTO_TEST Тестовый ли платеж. Булевский

 

 

5. Состояние счета    

Внимание! При данных запросах рекомендуется проверять SSL сертификат ответившего сервера для предотвращения DNS подлогов.

 

5.1. Доступный баланс

Доступно для вывода.

Элемент адреса Значение
Протокол https
Метод Get | Post (рекомендуется)
Путь https://paysto.com/api/Common/Balance

Параметры

Название Описание Тип Обязательный
PAYSTO_SHOP_ID Id Магазина, выдается при регистрации. Целое Да
PAYSTO_REQUEST_NO Сквозной (общий для всех типов запросов) порядковый номер запроса, каждое последующее значение должно быть больше предыдущего. Длинное целое Нет
PAYSTO_MD5 Подпись передаваемых данных. Контрольная сумма MD5. MD5 Да
PAYSTO_TEST Тестового ли счета баланс. булевский Нет

Ответы

Ответ Описание Тип
HTTP CODE 200 Скалярное значение. Доступный баланс. Денежный
HTTP CODE 403 Нарушены условия безопасности. Проверьте передаваемые параметры и настройки.  
HTTP CODE 404 Не найден магазин  

 

5.2. Ожидаемый баланс    

Все поступившие платежи зачислены; все блокировки сняты.

Элемент адреса Значение
Протокол https
Метод Get | Post (рекомендуется)
Путь https://paysto.com/api/Common/ExpectedBalance

Параметры

Название Описание Тип Обязательный
PAYSTO_SHOP_ID Id Магазина, выдается при регистрации. Целое Да
PAYSTO_REQUEST_NO Сквозной (общий для всех типов запросов) порядковый номер запроса, каждое последующее значение должно быть больше предыдущего. Длинное целое Нет
PAYSTO_MD5 Подпись передаваемых данных. Контрольная сумма MD5. MD5 Да
PAYSTO_TEST Тестового ли счета баланс. булевский Нет

Ответы

Ответ Описание Тип
HTTP CODE 200 Скалярное значение. Ожидаемый баланс. Денежный
HTTP CODE 403 Нарушены условия безопасности. Проверьте передаваемые параметры и настройки  
HTTP CODE 404 Не найден магазин  

 

5.3. Поступившие средства, всего    

Элемент адреса Значение
Протокол https
Метод Get | Post (рекомендуется)
Путь https://paysto.com/api/Common/Incom

Параметры

Название Описание Тип Обязательный
PAYSTO_SHOP_ID Id Магазина, выдается при регистрации. Целое Да
PAYSTO_REQUEST_NO Сквозной (общий для всех типов запросов) порядковый номер запроса, каждое последующее значение должно быть больше предыдущего. Длинное целое Нет
PAYSTO_MD5 Подпись передаваемых данных. Контрольная сумма MD5. MD5 Да
PAYSTO_TEST Тестового ли счета баланс. булевский Нет

Ответы

Ответ Описание Тип
HTTP CODE 200 Скалярное значение. Поступившие средства на счет клиента (в том числе и заблокированные и еще не зачисленные на счет). Денежный
HTTP CODE 403 Нарушены условия безопасности. Проверьте передаваемые параметры и настройки.  
HTTP CODE 404 Не найден магазин  

 

 

6. Настройки тарифа    

6.1. Список валют доступных для оплаты

Внимание! При данных запросах рекомендуется проверять SSL сертификат ответившего сервера для предотвращения DNS подлогов.

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

Элемент адреса Значение
Протокол https
Метод Get | Post (рекомендуется)
Путь https://paysto.com/api/Common/Currency

Параметры

Название Описание Тип Обязательный
PAYSTO_SHOP_ID Id Магазина, выдается при регистрации. Целое Да
PAYSTO_REQUEST_NO Сквозной (общий для всех типов запросов) порядковый номер запроса, каждое последующее значение должно быть больше предыдущего. Длинное целое Нет
PAYSTO_MD5 Подпись передаваемых данных. Контрольная сумма MD5. MD5 Да

Ответы

Ответ Формат Тип
HTTP CODE 200 CSV файл в виде PAYSTO_CURRENCY_ID,Name,Full_Name  
HTTP CODE 403 Нарушены условия безопасности. Проверьте передаваемые параметры и настройки.  
HTTP CODE 404 Не найден магазин  

Описание столбцов

Название Описание Тип
PAYSTO_CURRENCY_ID ID валюты, если данная валюта не доступна на странице оплаты – покупателю будет предложено выбрать валюту из доступных. Длинное целое
Name Короткое название валюты. Строка до 50 символов
Full_Name Полное название валюты. Строка до 50 символов

 

 

6.2. Список курсов    

Внимание! При данных запросах рекомендуется проверять SSL сертификат ответившего сервера для предотвращения DNS подлогов.

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

Элемент адреса Значение
Протокол https
Метод Get | Post (рекомендуется)
Путь https://paysto.com/api/Common/Rates

Параметры

Название Описание Тип Обязательный
PAYSTO_SHOP_ID Id Магазина, выдается при регистрации. Целое Да
PAYSTO_REQUEST_NO Сквозной (общий для всех типов запросов) порядковый номер запроса, каждое последующее значение должно быть больше предыдущего. Длинное целое Нет
PAYSTO_MD5 Подпись передаваемых данных. Контрольная сумма MD5. MD5 Да

Ответы

Ответ Формат Тип
HTTP CODE 200 CSV файл в виде PAYSTO_CURRENCY_ID,Rate,Min,Max,Fee,MinFee,MaxFee,PSFee,MinPSFee,MaxPSFee  
HTTP CODE 403 Нарушены условия безопасности. Проверьте передаваемые параметры и настройки.  
HTTP CODE 404 Не найден магазин  

Описание столбцов

Название Описание Тип
PAYSTO_CURRENCY_ID ID валюты, которой производится оплата Длинное целое
Rate Курс. Базовый курс конвертации. При нулевых комиссиях равен отношению суммы которую заплатят, к сумме на счет. Денежное
Min Минимально возможная сумма для оплаты Денежное
Max Максимально возможная сумма, для оплаты Денежное
Fee Комиссия Paysto, согласно тарифу Денежное
FeeMin Минимальная комиссия Paysto Денежное
FeeMax Максимальная комиссия Paysto Денежное
PSFee Комиссия платежной системы Денежное
MinPSFee Минимальная комиссия платежной системы Денежное
MaxPSFee Максимальная комиссия платежной системы Денежное

 

 

7. Аппендикс    

 

7.1. Данные получаемые из интерфейса Клиентского Кабинета.

Рисунок 1 Определение PAYSTO_SHOP_ID
[image]

 

 

7.2. Примеры использования:

Add Feedback