Skip to Content
Справочник APIAPI платежных шлюзов

API платежных шлюзов

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

Получение списка платежных шлюзов

Получение полного списка платежных шлюзов.

Запрос

GET /api/payment-gateways

Заголовки

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

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

НазваниеТипОписание
enabledbooleanНеобязательный. Фильтр по активности (true/false)
pageintegerНеобязательный. Номер страницы
limitintegerНеобязательный. Количество записей на странице

Ответ

{
  "payment_gateways": [
    {
      "id": 1,
      "name": "Банковская карта",
      "image": "/assets/img/payment/card.png",
      "adapter": "YooMoney",
      "enabled": true,
      "additional": {
        "shop_id": "12345",
        "secret_key": "********"
      }
    },
    {
      "id": 2,
      "name": "QIWI",
      "image": "/assets/img/payment/qiwi.png",
      "adapter": "Qiwi",
      "enabled": true,
      "additional": {
        "merchant_id": "67890",
        "api_key": "********"
      }
    }
  ],
  "pagination": {
    "total": 5,
    "per_page": 10,
    "current_page": 1,
    "last_page": 1
  }
}

Поля ответа

ПолеТипОписание
payment_gatewaysarrayМассив платежных шлюзов
idintegerID платежного шлюза
namestringНазвание платежного шлюза
imagestringПуть к изображению
adapterstringТип адаптера для шлюза
enabledbooleanСтатус шлюза (включен/выключен)
additionalobjectДополнительные настройки шлюза
paginationobjectИнформация о пагинации

Коды ответов

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

Получение данных платежного шлюза

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

Запрос

GET /api/payment-gateways/{id}

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

НазваниеТипОписание
idintegerID платежного шлюза

Заголовки

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

Ответ

{
  "payment_gateway": {
    "id": 1,
    "name": "Банковская карта",
    "image": "/assets/img/payment/card.png",
    "adapter": "YooMoney",
    "enabled": true,
    "additional": {
      "shop_id": "12345",
      "secret_key": "********"
    }
  }
}

Поля ответа

ПолеТипОписание
payment_gatewayobjectОбъект платежного шлюза
idintegerID платежного шлюза
namestringНазвание платежного шлюза
imagestringПуть к изображению
adapterstringТип адаптера для шлюза
enabledbooleanСтатус шлюза (включен/выключен)
additionalobjectДополнительные настройки шлюза

Коды ответов

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

Создание платежного шлюза

Создание нового платежного шлюза в системе.

Запрос

POST /api/payment-gateways

Заголовки

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

Тело запроса

{
  "name": "WebMoney",
  "image": "/assets/img/payment/webmoney.png",
  "adapter": "WebMoney",
  "enabled": true,
  "additional": {
    "merchant_id": "WM12345",
    "secret": "your_secret_key"
  }
}

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

НазваниеТипОписание
namestringОбязательный. Название платежного шлюза
imagestringОбязательный. Путь к изображению
adapterstringОбязательный. Тип адаптера для шлюза
enabledbooleanОбязательный. Статус шлюза (включен/выключен)
additionalobjectОбязательный. Дополнительные настройки шлюза

Ответ

{
  "message": "Payment gateway created successfully",
  "payment_gateway": {
    "id": 3,
    "name": "WebMoney",
    "image": "/assets/img/payment/webmoney.png",
    "adapter": "WebMoney",
    "enabled": true,
    "additional": {
      "merchant_id": "WM12345",
      "secret": "********"
    }
  }
}

Коды ответов

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

Обновление платежного шлюза

Обновление существующего платежного шлюза.

Запрос

PUT /api/payment-gateways/{id}

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

НазваниеТипОписание
idintegerID платежного шлюза

Заголовки

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

Тело запроса

{
  "name": "WebMoney WMR",
  "image": "/assets/img/payment/webmoney_updated.png",
  "enabled": false,
  "additional": {
    "merchant_id": "WM12345",
    "secret": "new_secret_key"
  }
}

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

НазваниеТипОписание
namestringНеобязательный. Название платежного шлюза
imagestringНеобязательный. Путь к изображению
adapterstringНеобязательный. Тип адаптера для шлюза
enabledbooleanНеобязательный. Статус шлюза (включен/выключен)
additionalobjectНеобязательный. Дополнительные настройки шлюза

Ответ

{
  "message": "Payment gateway updated successfully",
  "payment_gateway": {
    "id": 3,
    "name": "WebMoney WMR",
    "image": "/assets/img/payment/webmoney_updated.png",
    "adapter": "WebMoney",
    "enabled": false,
    "additional": {
      "merchant_id": "WM12345",
      "secret": "********"
    }
  }
}

Коды ответов

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

Удаление платежного шлюза

Удаление платежного шлюза из системы.

Запрос

DELETE /api/payment-gateways/{id}

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

НазваниеТипОписание
idintegerID платежного шлюза

Заголовки

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

Ответ

{
  "message": "Payment gateway deleted successfully"
}

Коды ответов

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

Изменение статуса платежного шлюза

Включение или отключение платежного шлюза.

Запрос

PUT /api/payment-gateways/{id}/status

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

НазваниеТипОписание
idintegerID платежного шлюза

Заголовки

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

Тело запроса

{
  "enabled": true
}

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

НазваниеТипОписание
enabledbooleanОбязательный. Статус шлюза (включен/выключен)

Ответ

{
  "message": "Payment gateway status updated successfully",
  "payment_gateway": {
    "id": 3,
    "name": "WebMoney WMR",
    "image": "/assets/img/payment/webmoney_updated.png",
    "adapter": "WebMoney",
    "enabled": true,
    "additional": {
      "merchant_id": "WM12345",
      "secret": "********"
    }
  }
}

Коды ответов

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

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

Получение списка доступных адаптеров для платежных шлюзов.

Запрос

GET /api/payment-gateways/adapters

Заголовки

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

Ответ

{
  "adapters": [
    {
      "id": "YooMoney",
      "name": "ЮMoney",
      "fields": [
        {
          "name": "shop_id",
          "type": "string",
          "required": true,
          "description": "Идентификатор магазина"
        },
        {
          "name": "secret_key",
          "type": "string",
          "required": true,
          "description": "Секретный ключ"
        }
      ]
    },
    {
      "id": "Qiwi",
      "name": "QIWI",
      "fields": [
        {
          "name": "merchant_id",
          "type": "string",
          "required": true,
          "description": "ID мерчанта"
        },
        {
          "name": "api_key",
          "type": "string",
          "required": true,
          "description": "API ключ"
        }
      ]
    }
  ]
}

Поля ответа

ПолеТипОписание
adaptersarrayМассив доступных адаптеров
idstringИдентификатор адаптера
namestringНазвание адаптера
fieldsarrayПоля настройки для адаптера
namestringНазвание поля
typestringТип поля (string, number, boolean)
requiredbooleanОбязательно ли поле
descriptionstringОписание поля

Коды ответов

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