Частичная оплата платежа с баланса

Метод используется для частичной оплаты платежа аккаунта, к которому есть доступ у текущего пользователя. Требования к платежу:

Это не платеж на пополнение баланса.
Этот платеж еще не был частично оплачен с баланса.
Сумма платежа строго больше суммы на балансе аккаунта с учетом порога срабатывания финансовой блокировки и возможности оплачивать платежи с отрицательным балансом.
Статус платежа Ожидает оплаты.

В результате вызова метода указанный платеж отменяется и создается новый платеж в статусе Ожидает оплаты на остаток суммы. Сумма частичной оплаты блокируется на балансе, транзакция не создается.

Метод возвращает информацию о созданном платеже. Код ответа 201 Created.

POST {reseller_domain}/internal_api/accounts/{account_id}/payments/{payment_id}/pay_partial_from_balance

В этой статье:

Авторизация

Требуется авторизация с помощью access token пользователя.

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
Content-Type	header	string	Обязательный	Тип данных, передаваемых в запросе. Укажите application/vnd.api+json
Accept	header	string	Обязательный	Поддерживаемые типы данных в ответе. Укажите application/vnd.api+json
X-Api-Locale	header	string	Опциональный	Двухбуквенный код языка данных в ответе
Authorization	header	string	Обязательный	Действующий access token пользователя. Формат: `Bearer <access token>`
reseller_domain	path	string	Обязательный	Доменное имя реселлера
account_id	path	integer	Обязательный	ID аккаунта
payment_id	path	integer	Обязательный	ID оплачиваемого платежа
amount	form	number	Обязательный	Сумма частичной оплаты

Модель ответа

Модель ответа соответствует методу Создание платежа.

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

Bash

curl --location --request POST 'https://test.activeplatform.com/internal_api/accounts/463/payments/2154/pay_partial_from_balance' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en' \
--header 'Authorization: Bearer AccessTokenExample' \
--data '{
    "data": {
        "attributes": {
            "amount": 22.6 
        }
    }
}'

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

JSON

{
    "data": {
        "id": "2151",
        "type": "payments",
        "attributes": {
            "created_at": "2025-07-25T17:53:03.106424+0300",
            "document_id": "002007",
            "status": "waiting_for_payment",
            "total": 100.0,
            "amount_paid_from_balance": 22.6,
            "initial_total": 122.6,
            "reseller_currency_iso_code": "USD",
            "payment_model": "prepay",
            "is_topup": false,
            "purpose": "",
            "is_joined": false,
            "topup_sum": 0.0,
            "due_date": "2025-08-01",
            "closed_at": "",
            "payment_method_attributes": null,
            "invoice_data": [],
            "external_invoice_generation": false,
            "orders": [
                {
                    "id": 4517,
                    "document_id": "SO002106",
                    "type": "SalesOrder",
                    "subtype": null,
                    "total": 122.6,
                    "subscription": {
                        "id": 2308,
                        "name": "Monthly Prolongation",
                        "billing_type": "csp_monthly",
                        "payment_model": "prepay"
                    },
                    "detail_items": [
                        {
                            "description": "\"License\" for subscription #2308 \"Monthly Prolongation\" from 25.07.2025 to 31.07.2025 (setup fee)",
                            "quantity_float": "100.0",
                            "duration_float": "--",
                            "unit_price": "1.00 USD",
                            "discount_amount": "0.00 USD",
                            "amount": "100.00 USD"
                        },
                        {
                            "description": "\"License\" for subscription #2308 \"Monthly Prolongation\" from 25.07.2025 to 31.07.2025 (recurring fee)",
                            "quantity_float": "100.0",
                            "duration_float": "0.226",
                            "unit_price": "1.00 USD",
                            "discount_amount": "0.00 USD",
                            "amount": "22.60 USD"
                        }
                    ]
                }
            ],
            "available_operations": {
                "cancel": true,
                "recreate": true,
                "pay": true,
                "pay_from_balance": false,
                "partial_pay": false,
                "separate": false,
                "join": true,
                "autopay_from_balance": false
            },
            "processing_error": null,
            "taxes_total": null,
            "charges": []
        },
        "relationships": {
            "charges": {
                "data": [
                    {
                        "id": "15545",
                        "type": "charge_setups"
                    },
                    {
                        "id": "15546",
                        "type": "charge_recurrings"
                    }
                ]
            }
        }
    },
    "meta": {
        "server_current_time": "2025-07-25T17:53:03.362184+0300"
    }
}