FireKassa API v2
  • FireKassa API v2
    • Правила сотрудничества с площадкой VanilaPay/FirePay
  • Общая информация
    • 💡Что нового?
    • 🛡️Безопасность
    • 🐞Обработка ошибок
    • 🪝Вебхуки
  • Счета
    • 📋Список счетов
    • 📄Просмотр счета
    • 📋Карточные методы
    • 📋Платежные методы
    • 📋Доступность методов
    • Курсы конвертации со счета на счет
  • Инвойсы
    • 📋Список инвойсов
    • 📄Просмотр инвойса
    • ➕Создание инвойса
    • ❌Отмена инвойса
  • Транзакции
    • 📋Список транзакций
    • 📄Просмотр транзакции
    • 🖤Проверка на наличие карты в черном списке
    • ✒️Добавление карты в черный список
    • Загрузка чека
    • 🤑Заявки на ввод
      • ➕Создание заявки на ввод
        • Карта
        • H2H
        • СБП
        • СБП (с)
        • USDT TRC20
        • USDT ERC20
      • ❌Отмена заявки на ввод
      • ⚡Передача сигнала об оплате
    • 💸Заявки на вывод
      • ➕Создание заявки на вывод
        • Карта
        • СБП
        • Телефон
        • Кошелек QIWI
        • Кошелек ЮMoney
        • USDT TRC20
        • USDT ERC20
        • Code
        • ECommerce (Оплата товара)
        • Счет (вывод на счет по реквизитам)
      • ❌Отмена заявки на вывод
      • 📋Перечень банков для СБП
      • 🧾Список банков для СБП на 24.04.2024
  • Premium Exchanger Modules
    • Прием платежей
    • Автовыплаты
      • Настройка автовыплат на сбп
Powered by GitBook
On this page
  • 1. Отказались от передачи значений в GET параметрах
  • 2. Переименовали часть параметров
  • 3. Добавили подпись запросов
  • 4. Добавили счета
  • 5. Добавили возможность указать индивидуальный урл для уведомления по транзакции
  • 6. Добавлен белый список айпи для API запросов
  • 7. Добавили возможность отменить заявку на ввод и вывод
  • 8. Добавили возможность отметить заявку на ввод как оплаченную
  • 9. Добавили возможность указать язык для коммуникации
  1. Общая информация

Что нового?

PreviousПравила сотрудничества с площадкой VanilaPay/FirePayNextБезопасность

Last updated 7 months ago

1. Отказались от передачи значений в GET параметрах

Ранее все параметры по созданию заявки указывались в GET параметрах, что не очень удобно и не всегда безопасно, особенно когда говорим про передачу token. В новой версии API в GET параметрах передаются только естественные для этого вещи - параметры фильтрации для списков, а токен апи перекочевал в заголовок Authorization.

Для примера, ранее запрос на создание заявки на ввод по методу wallet на сумму 100 рублей выглядел следующим образом:

curl --request GET \
  --url 'https://admin.vanilapay.com/api/v1/deposit?token=****&amount=100&method=wallet&order_id=test1'

Теперь этот же запрос будет выглядеть следующим образом:

curl --request POST \
  --url https://admin.vanilapay.com/api/v2/deposit \
  --header 'Authorization: Bearer ****' \
  --header 'Content-Type: application/json' \
  --data '{
  "order_id": "test1",
  "method": "wallet",
  "amount": "100.00"
}'

2. Переименовали часть параметров

Изначально все расширенные данные по операции передавались в массиве extended_data, который именно так и назывался. В итоге для того чтобы передать юзер агент, приходилось сооружать такой вот параметр extended_data[user_agent].

На текущий момент вместо массива используется просто приставка ext_, т.е. для передачи user_agent нужно использовать параметр ext_user_agent.

На выводе использовался параметр number, теперь вместо него параметр account, что больше соответствует логике.

3. Добавили подпись запросов

Детальнее в разделе безопасности

4. Добавили счета

Детальнее в разделе о счетах

5. Добавили возможность указать индивидуальный урл для уведомления по транзакции

Ранее уведомления по всем транзакциям шли через урл для уведомлений, указанный в карточке сайта. В некоторых случаях это оказалось не очень удобно, поскольку некоторые интеграции были реализованы так, что не могли принимать уведомления на одну и ту же ссылку.

Поэтому была реализована возможность указать ссылку для уведомления по каждой транзакции индивидуально, посредством параметра notification_url. Это опциональный параметр, потому если вам это не требуется, то можете и не указывать его. Но если вам по какой-то причине это нужно, то делается это следующим образом:

curl --request POST \
  --url https://admin.vanilapay.com/api/v2/deposit \
  --header 'Authorization: Bearer ****' \
  --header 'Signature: 1234567890' \
  --header 'Content-Type: application/json' \
  --data '{
  "order_id": "test1",
  "method": "wallet",
  "amount": "100.00",
  "site_account": "tinkoff",
  "notification_url": "https://ваш-домен.ком/ваша/ссылка"
}'

6. Добавлен белый список айпи для API запросов

Детальнее в разделе о безопасности.

Ранее такой список айпи использовался только для заявок на вывод, но теперь есть аналогичный список для API v2, который распространяется абсолютно на все запросы API v2.

Отредактировать белый список айпи можно в карточке сайта

7. Добавили возможность отменить заявку на ввод и вывод

Детальнее в соответствующих разделах

8. Добавили возможность отметить заявку на ввод как оплаченную

Детальнее в соответствующем разделе

9. Добавили возможность указать язык для коммуникации

Если по какой-то причине вас не устраивает русский язык в ответах ( например вы неправильно работаете с юникодом в ответах от апи ), то можете использовать английский язык. Для этого в запросе надо указать заголовок Accept-Language со значением en_US. Пример того как это будет выглядеть:

curl --request POST \
  --url https://admin.vanilapay.com/api/v2/deposit \
  --header 'Authorization: Bearer ****' \
  --header 'Accept-Language: en_US' 
...  

Детально по названиям параметров и

💡
тут
тут