Skip to Content

API валют

Эндпоинты для управления валютами в системе.

Получение списка валют

Получение полного списка валют.

Запрос

GET /api/currencies

Заголовки

НазваниеТипОписание
X-API-KeystringОбязательный. API ключ

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

НазваниеТипОписание
pageintegerНеобязательный. Номер страницы
limitintegerНеобязательный. Количество записей на странице

Ответ

{ "currencies": [ { "id": 1, "code": "USD", "minimum_value": 1.0, "exchange_rate": 1.0 }, { "id": 2, "code": "EUR", "minimum_value": 1.0, "exchange_rate": 0.85 }, { "id": 3, "code": "RUB", "minimum_value": 100.0, "exchange_rate": 75.5 } ], "pagination": { "total": 5, "per_page": 10, "current_page": 1, "last_page": 1 } }

Поля ответа

ПолеТипОписание
currenciesarrayМассив валют
idintegerID валюты
codestringКод валюты
minimum_valuenumberМинимальное значение для платежа
exchange_ratenumberОбменный курс относительно базовой валюты
paginationobjectИнформация о пагинации

Коды ответов

КодОписание
200Успешный запрос
401Неверный API ключ или отсутствует
403Недостаточно прав для выполнения запроса

Получение данных валюты

Получение детальной информации о конкретной валюте.

Запрос

GET /api/currencies/{id}

Параметры пути

НазваниеТипОписание
idintegerID валюты

Заголовки

НазваниеТипОписание
X-API-KeystringОбязательный. API ключ

Ответ

{ "currency": { "id": 1, "code": "USD", "minimum_value": 1.0, "exchange_rate": 1.0 } }

Поля ответа

ПолеТипОписание
currencyobjectОбъект валюты
idintegerID валюты
codestringКод валюты
minimum_valuenumberМинимальное значение для платежа
exchange_ratenumberОбменный курс относительно базовой валюты

Коды ответов

КодОписание
200Успешный запрос
401Неверный API ключ или отсутствует
403Недостаточно прав для выполнения запроса
404Валюта не найдена

Создание валюты

Создание новой валюты в системе.

Запрос

POST /api/currencies

Заголовки

НазваниеТипОписание
X-API-KeystringОбязательный. API ключ
Content-TypestringОбязательный. application/json

Тело запроса

{ "code": "GBP", "minimum_value": 1.0, "exchange_rate": 0.75 }

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

НазваниеТипОписание
codestringОбязательный. Код валюты (3 символа)
minimum_valuenumberОбязательный. Минимальное значение для платежа
exchange_ratenumberОбязательный. Обменный курс

Ответ

{ "message": "Currency created successfully", "currency": { "id": 4, "code": "GBP", "minimum_value": 1.0, "exchange_rate": 0.75 } }

Коды ответов

КодОписание
201Валюта успешно создана
401Неверный API ключ или отсутствует
403Недостаточно прав для выполнения запроса
422Неверные параметры запроса

Обновление валюты

Обновление существующей валюты.

Запрос

PUT /api/currencies/{id}

Параметры пути

НазваниеТипОписание
idintegerID валюты

Заголовки

НазваниеТипОписание
X-API-KeystringОбязательный. API ключ
Content-TypestringОбязательный. application/json

Тело запроса

{ "code": "GBP", "minimum_value": 2.0, "exchange_rate": 0.78 }

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

НазваниеТипОписание
codestringНеобязательный. Код валюты (3 символа)
minimum_valuenumberНеобязательный. Минимальное значение для платежа
exchange_ratenumberНеобязательный. Обменный курс

Ответ

{ "message": "Currency updated successfully", "currency": { "id": 4, "code": "GBP", "minimum_value": 2.0, "exchange_rate": 0.78 } }

Коды ответов

КодОписание
200Валюта успешно обновлена
401Неверный API ключ или отсутствует
403Недостаточно прав для выполнения запроса
404Валюта не найдена
422Неверные параметры запроса

Удаление валюты

Удаление валюты из системы.

Запрос

DELETE /api/currencies/{id}

Параметры пути

НазваниеТипОписание
idintegerID валюты

Заголовки

НазваниеТипОписание
X-API-KeystringОбязательный. API ключ

Ответ

{ "message": "Currency deleted successfully" }

Коды ответов

КодОписание
200Валюта успешно удалена
401Неверный API ключ или отсутствует
403Недостаточно прав для выполнения запроса
404Валюта не найдена
409Валюта используется и не может быть удалена

Установка валюты по умолчанию

Установка валюты в качестве используемой по умолчанию.

Запрос

POST /api/currencies/{id}/default

Параметры пути

НазваниеТипОписание
idintegerID валюты

Заголовки

НазваниеТипОписание
X-API-KeystringОбязательный. API ключ

Ответ

{ "message": "Currency set as default successfully", "currency": { "id": 1, "code": "USD", "minimum_value": 1.0, "exchange_rate": 1.0, "is_default": true } }

Коды ответов

КодОписание
200Валюта успешно установлена по умолчанию
401Неверный API ключ или отсутствует
403Недостаточно прав для выполнения запроса
404Валюта не найдена