Сертификаты для оплаты

---

Документация API для работы с сертификатами оплаты

Таблица с описанием полей

Поле	Тип	Обязательное?	Описание
id	int	Нет	Уникальный идентификатор сертификата (обязателен при обновлении).
code	string	Да	Уникальный код сертификата.
is_active	bool	Нет	Статус активности сертификата (по умолчанию — true).
value	int	Нет	Номинальная стоимость сертификата.

1. Получение всех сертификатов

Метод: GET
URL: {domain}/external/payment-certificate/

Описание:
Возвращает список всех сертификатов оплаты сайта.

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

GET {domain}/external/payment-certificate/

Пример ответа:

[
    {
        "id": 1,
        "code": "CERT-001",
        "is_active": true,
        "value": 500
    },
    {
        "id": 2,
        "code": "CERT-002",
        "is_active": false,
        "value": 1000
    }
]

2. Получение одного сертификата

Метод: GET
URL: {domain}/external/payment-certificate/{id}/

Описание:
Возвращает данные одного сертификата по его идентификатору.

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

GET {domain}/external/payment-certificate/1/

Пример ответа:

{
    "id": 1,
    "code": "CERT-001",
    "is_active": true,
    "value": 500
}

3. Обновление одного сертификата

Метод: PUT
URL: {domain}/external/payment-certificate/{id}/

Описание:
Обновляет данные одного сертификата по его идентификатору.

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

PUT {domain}/external/payment-certificate/1/
Content-Type: application/json

Тело запроса:

{
    "code": "CERT-001-UPDATED",
    "is_active": false,
    "value": 750
}

Пример ответа:

{
    "id": 1,
    "code": "CERT-001-UPDATED",
    "is_active": false,
    "value": 750
}

4. Создание нескольких сертификатов

Метод: POST
URL: {domain}/external/payment-certificate/bulk-create/

Описание:
Создаёт несколько сертификатов одновременно.

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

POST {domain}/external/payment-certificate/bulk-create/
Content-Type: application/json

Тело запроса:

[
    {
        "code": "CERT-NEW-001",
        "is_active": true,
        "value": 1000
    },
    {
        "code": "CERT-NEW-002",
        "is_active": false,
        "value": 1500
    }
]

Пример ответа:

[
    {
        "id": 3,
        "code": "CERT-NEW-001",
        "is_active": true,
        "value": 1000
    },
    {
        "id": 4,
        "code": "CERT-NEW-002",
        "is_active": false,
        "value": 1500
    }
]

5. Обновление нескольких сертификатов

Метод: PUT
URL: {domain}/external/payment-certificate/bulk-update/

Описание:
Обновляет данные нескольких сертификатов одновременно.

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

PUT {domain}/external/payment-certificate/bulk-update/
Content-Type: application/json

Тело запроса:

[
    {
        "id": 1,
        "code": "CERT-001-UPDATED",
        "value": 800,
        "is_active": true
    },
    {
        "id": 2,
        "code": "CERT-002-UPDATED",
        "value": 1200,
        "is_active": true
    }
]

Пример ответа:

[
    {
        "id": 1,
        "code": "CERT-001-UPDATED",
        "is_active": true,
        "value": 800
    },
    {
        "id": 2,
        "code": "CERT-002-UPDATED",
        "is_active": true,
        "value": 1200
    }
]

---

Была ли статья полезна?

Да, спасибо! К сожалению, нет