Работа документами

Точка подключения:

Прием документа (POST)

Параметры запроса:

Параметр Тип данных Описание Обязательный
guid string GUID документа Да

Пример овтета:

Параметры ответа:

Параметр Тип данных Описание Обязательный
id integer Идентификатор документа Да

Получение документа (POST)

Параметры запроса:

Параметр Тип данных Описание Обязательный
guid string GUID документа Да

Пример овтета:

Параметры ответа:

Параметр Тип данных Описание Обязательный
id integer Идентификатор документа Да

Работа с именами

Точка подключения:

Подтверждение имени отправителя (POST)

Параметры запроса:

Параметр Тип данных Описание Обязательный
guid string GUID sender_name Да

Пример овтета:

Параметры ответа:

Параметр Тип данных Описание Обязательный
id integer Идентификатор документа Да

Отклонение имени отправителя (POST)

Параметры запроса:

Параметр Тип данных Описание Обязательный
guid string GUID sender_name Да

Пример овтета:

Параметры ответа:

Параметр Тип данных Описание Обязательный
id integer Идентификатор документа Да

Работа с балансом

Точка подключения:

Запрос баланса (GET)

Пример овтета:

Параметры ответа:

Параметр Тип данных Описание Обязательный
balance integer Баланс компании Да
balance_currency string Валюта Да

Вывод списка платежей (GET)

Параметры запроса:

Параметр Тип данных Описание Обязательный
start_date date Дата начала выборки. Формат dd.mm.yyyy Да
end_date date Дата конца выборки. Формат dd.mm.yyyy Да
page integer Номер страницы Нет
per_page integer Кол-во записей Нет

Пример овтета:

Параметры ответа:

Параметр Тип данных Описание Обязательный
created_at string Дата операции Да
customer_inn string ИНН покупателя Да
customer_name string Наименование покупателя Да
payment_purpose string Назначение платежа Да
amount string Сумма Да
receiver_inn string ИНН получателя Да
receiver_name string Наименование получателя Да
id integer Идентификатор платежа (ID транзакции) Да

Пополнение баланса (POST)

Параметры запроса:

Параметр Тип данных Описание Обязательный
guid string GUID Да
amount integer Сумма Да

Пример овтета:

Параметры ответа:

Параметр Тип данных Описание Обязательный
created_at string Дата операции Да
customer_inn string ИНН покупателя Да
customer_name string Наименование покупателя Да
payment_purpose string Назначение платежа Да
amount string Сумма Да
receiver_inn string ИНН получателя Да
receiver_name string Наименование получателя Да
id integer Идентификатор платежа (ID транзакции) Да

Ключи доступа к API (POST)

Данный запросом производится получение аутентификационного токена.

Параметры запроса:

Параметр Тип данных Описание Обязательный
phone string Телефон Да
password string Пароль для входа Да

Пример овтета:

Параметры ответа:

Коды ошибок

HTTP status code Описание
401 Неверный токен или формат заголовка
403 Нет прав доступа к ресурсу
404 Запрашиваемый ресурс не найден
422 Ошибка валидации