Получение доступных методов оплаты

Запрос

URL

https://api.mivion.com/shops/{shopId}/payment-tariffs

Метод отправки

GET

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

nametypedescription
shopId*uuidИдентификатор кассы (используется для авторизации, подставляется в ссылку)
type
uuid
description
Идентификатор кассы (используется для авторизации, подставляется в ссылку)

* Поля обязательные для заполнения

** Поля обязательные в случае отсутствия другого такого же поля

Ответ после запроса

Формат ответа

JSON

nametypedescription
tariffsarrayМассив тарифов
tariffs.*objectЭлемент массива
tariffs.*.percentnumberОбщий процент комиссии
tariffs.*.fixnumberФиксированная коммиссия
tariffs.*.min_sumnumberМинимальная сумма оплаты
tariffs.*.max_sumnumberМаксимальная сумма оплаты
tariffs.*.shop_percentnumberПроцент комиссии, взимаемый с кассы
tariffs.*.user_percentnumberПроцент комиссии, взимаемый с клиента
tariffs.*.servicestringКод метода оплаты *
tariffs.*.service_labelstringНазвание метода оплаты
tariffs.*.currencystringВалюта *
tariffs.*.statusstringСтатус тарифа
Вариантыenabled - Включен
disabled - Выключен
type
array
description
Массив тарифов
type
object
description
Элемент массива
type
number
description
Общий процент комиссии
type
number
description
Фиксированная коммиссия
type
number
description
Минимальная сумма оплаты
type
number
description
Максимальная сумма оплаты
type
number
description
Процент комиссии, взимаемый с кассы
type
number
description
Процент комиссии, взимаемый с клиента
type
string
description
Код метода оплаты *
type
string
description
Название метода оплаты
type
string
description
Валюта *
type
string
description
Статус тарифа
Вариантыenabled - Включен
disabled - Выключен

Возможные статусы ответа:

  • 200 : Успех
  • 401 : Ошибка авторизации (неверный shopId или секретный ключ)
  • 404 : Тарифы не найдены
  • 422 : Ошибка валидации
  • 500 : Внутренняя ошибка системы

Пример запроса:

URL

https://api.mivion.com/shops/44a90940-8206-4438-a71e-5702a9c11f5f/payment-tariffs

Метод отправки

GET

Curl

  1. 1.curl -X 'GET' \
  2. 2.'https://api.mivion.com/shops/44a90940-8206-4438-a71e-5702a9c11f5f/payment-tariffs' \
  3. 3.-H 'accept: application/json' \
  4. 4.-H 'x-api-key: 31ecdd3106fc793c076923bc467bc7daec9b0c51'

Responses

При успешном запросе: код ответа - 200

  1. 1.{
  2. 2. "data": {
  3. 3. "tariffs": [
  4. 4. {
  5. 5. "percent": 0,
  6. 6. "max_sum": 0,
  7. 7. "shop_percent": 0,
  8. 8. "user_percent": 0,
  9. 9. "service": "card",
  10. 10. "service_label": "Банковская карта",
  11. 11. "currency": "RUB",
  12. 12. "status": "string"
  13. 13. }
  14. 14. ]
  15. 15. },
  16. 16. "status": 200,
  17. 17. "status_check": true
  18. 18.}

При ошибке: код ответа - 401, 404, 422, 500

  1. 1.{
  2. 2. "data": null,
  3. 3. "error": "Внутренняя ошибка системы, попробуйте позже",
  4. 4. "status": 500,
  5. 5. "status_check": false
  6. 6.}

Примеры кода:

  1. 1.import requests
  2. 2.
  3. 3.
  4. 4.# Payment tariffs
  5. 5.def get_payment_tariffs(shop_id, api_key):
  6. 6. session = requests.Session()
  7. 7. session.headers['Accept'] = 'application/json'
  8. 8. session.headers['x-api-key'] = api_key
  9. 9. response = session.get(f'https://api.mivion.com/shops/{shop_id}/payment-tariffs')
  10. 10. return response.json()
  11. 11.
  12. 12.
  13. 13.shop_id = '44a90940-8206-4438-a71e-5702a9c11f5f'
  14. 14.api_key = '31ecdd3106fc793c076923bc467bc7daec9b0c51'
  15. 15.
  16. 16.# Response full info
  17. 17.payment_tariffs = get_payment_tariffs(shop_id, api_key)
  18. 18.
  19. 19.# Response status
  20. 20.payment_tariffs['status']
  21. 21.
  22. 22.# Tariffs list
  23. 23.payment_tariffs['data']['tariffs']
  24. 24.
  25. 25.# Tariff info
  26. 26.payment_tariffs['data']['tariffs'][0]['percent']
  27. 27.payment_tariffs['data']['tariffs'][0]['service']
  28. 28.payment_tariffs['data']['tariffs'][0]['currency']
  29. 29.payment_tariffs['data']['tariffs'][0]['status']
  1. 1.function getPaymentTariffs(string $shopId, string $apiKey): array
  2. 2.{
  3. 3. $url = "https://api.mivion.com/shops/{$shopId}/payment-tariffs";
  4. 4. $headers = [
  5. 5. "accept: application/json",
  6. 6. "x-api-key: {$apiKey}"
  7. 7. ];
  8. 8.
  9. 9. $ch = curl_init();
  10. 10. curl_setopt($ch, CURLOPT_URL, $url);
  11. 11. curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
  12. 12. curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
  13. 13. $response = curl_exec($ch);
  14. 14. curl_close($ch);
  15. 15. return json_decode($response, true);
  16. 16.}
  17. 17.
  18. 18.$shopId = "44a90940-8206-4438-a71e-5702a9c11f5f";
  19. 19.$apiKey = "31ecdd3106fc793c076923bc467bc7daec9b0c51";
  20. 20.
  21. 21.# Response full info
  22. 22.$tariffs = getPaymentTariffs($shopId, $apiKey);
  23. 23.
  24. 24.# Response status
  25. 25.$tariffs['status'];
  26. 26.
  27. 27.# Tariffs list
  28. 28.$tariffs['data'];
  29. 29.
  30. 30.# Tariff info
  31. 31.$tariffs['data']['tariffs'][0]['percent'];
  32. 32.$tariffs['data']['tariffs'][0]['service'];
  33. 33.$tariffs['data']['tariffs'][0]['currency'];
  34. 34.$tariffs['data']['tariffs'][0]['status'];