API валют
Эндпоинты для управления валютами в системе.
Получение списка валют
Получение полного списка валют.
Запрос
GET /api/currencies
Заголовки
Название | Тип | Описание |
---|---|---|
X-API-Key | string | Обязательный. API ключ |
Параметры запроса
Название | Тип | Описание |
---|---|---|
page | integer | Необязательный. Номер страницы |
limit | integer | Необязательный. Количество записей на странице |
Ответ
{
"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
}
}
Поля ответа
Поле | Тип | Описание |
---|---|---|
currencies | array | Массив валют |
id | integer | ID валюты |
code | string | Код валюты |
minimum_value | number | Минимальное значение для платежа |
exchange_rate | number | Обменный курс относительно базовой валюты |
pagination | object | Информация о пагинации |
Коды ответов
Код | Описание |
---|---|
200 | Успешный запрос |
401 | Неверный API ключ или отсутствует |
403 | Недостаточно прав для выполнения запроса |
Получение данных валюты
Получение детальной информации о конкретной валюте.
Запрос
GET /api/currencies/{id}
Параметры пути
Название | Тип | Описание |
---|---|---|
id | integer | ID валюты |
Заголовки
Название | Тип | Описание |
---|---|---|
X-API-Key | string | Обязательный. API ключ |
Ответ
{
"currency": {
"id": 1,
"code": "USD",
"minimum_value": 1.0,
"exchange_rate": 1.0
}
}
Поля ответа
Поле | Тип | Описание |
---|---|---|
currency | object | Объект валюты |
id | integer | ID валюты |
code | string | Код валюты |
minimum_value | number | Минимальное значение для платежа |
exchange_rate | number | Обменный курс относительно базовой валюты |
Коды ответов
Код | Описание |
---|---|
200 | Успешный запрос |
401 | Неверный API ключ или отсутствует |
403 | Недостаточно прав для выполнения запроса |
404 | Валюта не найдена |
Создание валюты
Создание новой валюты в системе.
Запрос
POST /api/currencies
Заголовки
Название | Тип | Описание |
---|---|---|
X-API-Key | string | Обязательный. API ключ |
Content-Type | string | Обязательный. application/json |
Тело запроса
{
"code": "GBP",
"minimum_value": 1.0,
"exchange_rate": 0.75
}
Параметры тела запроса
Название | Тип | Описание |
---|---|---|
code | string | Обязательный. Код валюты (3 символа) |
minimum_value | number | Обязательный. Минимальное значение для платежа |
exchange_rate | number | Обязательный. Обменный курс |
Ответ
{
"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}
Параметры пути
Название | Тип | Описание |
---|---|---|
id | integer | ID валюты |
Заголовки
Название | Тип | Описание |
---|---|---|
X-API-Key | string | Обязательный. API ключ |
Content-Type | string | Обязательный. application/json |
Тело запроса
{
"code": "GBP",
"minimum_value": 2.0,
"exchange_rate": 0.78
}
Параметры тела запроса
Название | Тип | Описание |
---|---|---|
code | string | Необязательный. Код валюты (3 символа) |
minimum_value | number | Необязательный. Минимальное значение для платежа |
exchange_rate | number | Необязательный. Обменный курс |
Ответ
{
"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}
Параметры пути
Название | Тип | Описание |
---|---|---|
id | integer | ID валюты |
Заголовки
Название | Тип | Описание |
---|---|---|
X-API-Key | string | Обязательный. API ключ |
Ответ
{
"message": "Currency deleted successfully"
}
Коды ответов
Код | Описание |
---|---|
200 | Валюта успешно удалена |
401 | Неверный API ключ или отсутствует |
403 | Недостаточно прав для выполнения запроса |
404 | Валюта не найдена |
409 | Валюта используется и не может быть удалена |
Установка валюты по умолчанию
Установка валюты в качестве используемой по умолчанию.
Запрос
POST /api/currencies/{id}/default
Параметры пути
Название | Тип | Описание |
---|---|---|
id | integer | ID валюты |
Заголовки
Название | Тип | Описание |
---|---|---|
X-API-Key | string | Обязательный. 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 | Валюта не найдена |