Описание апи функционала

Pegas-kassa

Pegas-kassa — универсальное решение для работы с онлайн-платежами. API построено на REST-принципах, работает с реальными объектами и обладает предсказуемым поведением. С помощью этого API вы можете отправлять запросы на оплату, совершать возвраты, производить выплаты, получать информацию о созданных платежах, а также многое другое.

API в качестве основного протокола использует HTTP, а значит, подходит для разработки на любом языке программирования, который умеет работать с HTTP-библиотеками (например, cURL)

API поддерживает POST и GET-запросы. POST-запросы используют JSON-аргументы, GET-запросы работают со строками запросов. API всегда возвращает ответ в формате JSON, независимо от типа запроса.

Создать счет на оплату:

GET: https://Pegas-kassa/api/v1/deposit

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

token
Обязательный
Ваш токен сайта, отображается в личном кабинете.
amount
Обязательный
Сумма на оплату.
type
Обязательный
Тип ввода:

wallet - прямая оплата на кошелек ( например через терминал )
wallet-card - прямая оплата
invoice-qw - оплата по ссылке
invoice-card - оплата по ссылке, при переходе пользователю будет показан метод ввода по карте
invoice-select - оплата по ссылке, при переходе пользователю будет предложено оплатить по карте или с кошелька
yandex - оплата через ЮMoney
order_id
Обязательный
Ваш идентификатор оплаты.
phone
Номер телефона пользователя (в международном формате) для invoice-qw
qiwi_account
Номер отправителя, для invoice
ttl
Время жизни, в минутах. Нужно для типа wallet
success_url
Ссылка, куда необходимо отправить пользователя после успешной оплаты (необязательно) для invoice-qw

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

Ответ

id
ID оплаты
commission
Комиссия
url
Ссылка на оплату при payment_method=invoice
wallet
Номер кошелька для оплаты при payment_method=wallet
card
Номер карты для оплаты при payment_method=wallet
errors
Ошибки [...]

Отменить счет на оплату:

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

GET: https://Pegas-kassa/api/v1/deposit/cancel
token
Обязательный
Ваш токен сайта, отображается в личном кабинете.
order_id
Обязательный
Ваш идентификатор оплаты.
id
Обязательный
Наш идентификатор оплаты

Ответ

id
ID оплаты

Создать заявку на выплату:

GET: https://Pegas-kassa/api/v1/withdrawal

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

token
Обязательный
Ваш токен сайта, отображается в личном кабинете.
amount
Обязательный
Сумма на оплату.
number
Обязательный
Номер счета (номер киви кошелька, номер карты и тд)
method
Обязательный
Варианты методов следующие:

wallet - киви
yandex - ЮMoney
card - карта
nickname - никнейм
phone - вывод на телефон
yandex - оплата через ЮMoney
comment
Комментарий (min:3 max:100)
order_id
Ваш идентификатор оплаты
ttl
Время жизни, в минутах. Нужно для типа wallet

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

Ответ

id
ID оплаты
commission
Комиссия
errors
Ошибки [...]
Нет информации, обратитесь к тех-поддержке, если требуется помощь.
Нет информации, обратитесь к тех-поддержке, если требуется помощь.
Нет информации, обратитесь к тех-поддержке, если требуется помощь.

Получение квитанции:

GET: https://Pegas-kassa/api/v1/transaction/receipt/file

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

token
Обязательный
Ваш токен сайта, отображается в личном кабинете.
order_id
Не обязательный в случае передачи id
Ваш идентификатор оплаты
id
Не обязательный в случае передачи order_id
Наш идентификатор оплаты
format
Обязательный
Формат документа, доступные значения:
- pdf
- jpeg

Получение баланса по сайту:

GET: https://Pegas-kassa/api/v1/balance

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

token
Обязательный
Ваш токен сайта, отображается в личном кабинете.

Ответ

balance
Текущий баланс сайта

Ошибки:

В случае возникновения ошибок API вернет объект ошибки и HTTP-код отличный от 200. Структура объекта ошибки:

HTTP-код Описание Error code
200 Успешно обработан
400 Неверный запрос parsing_error, invalid_parameters или provider_error
401 Ошибка авторизации (неверный ключ) authorization_error
403 Доступ к ресурсу запрещен access_denied
404 Ресурс не найден resource_not_found
500 Внутренняя ошибка системы internal_error

Если возникает ошибка валидации, то в ошибку добавляется поле validation_error которое содержит в себе path - путь до поля с ошибкой, разделенный точкой и message - сообщение об ошибке.