Отмена частичной оплаты платежа с баланса

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

Этот платеж ранее был частично оплачен с баланса (см. Частичная оплата платежа с баланса).
Статус платежа Ожидает оплаты.

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

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

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

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

Авторизация

Требуется авторизация с помощью 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 платежа

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

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

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

Bash

curl --location --request POST 'https://test.activeplatform.com/internal_api/accounts/463/payments/2159/cancel_partial_payment' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en' \
--header 'Authorization: Bearer AccessTokenExample'

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

JSON

{
    "data": {
        "id": "2160",
        "type": "payments",
        "attributes": {
            "created_at": "2025-07-28T10:23:32.510306+0300",
            "document_id": "002016",
            "status": "waiting_for_payment",
            "total": 112.9,
            "amount_paid_from_balance": null,
            "initial_total": 112.9,
            "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": 4518,
                    "document_id": "SO002107",
                    "type": "SalesOrder",
                    "subtype": null,
                    "total": 112.9,
                    "subscription": {
                        "id": 2309,
                        "name": "Office",
                        "billing_type": "csp_monthly",
                        "payment_model": "prepay"
                    },
                    "detail_items": [
                        {
                            "description": "\"License\" for subscription #2309 \"Office\" from 28.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 #2309 \"Office\" from 28.07.2025 to 31.07.2025 (recurring fee)",
                            "quantity_float": "100.0",
                            "duration_float": "0.129",
                            "unit_price": "1.00 USD",
                            "discount_amount": "0.00 USD",
                            "amount": "12.90 USD"
                        }
                    ]
                }
            ],
            "available_operations": {
                "cancel": true,
                "recreate": true,
                "pay": true,
                "pay_from_balance": false,
                "partial_pay": true,
                "separate": false,
                "join": true,
                "autopay_from_balance": false
            },
            "processing_error": null,
            "taxes_total": null,
            "charges": []
        },
        "relationships": {
            "charges": {
                "data": [
                    {
                        "id": "15549",
                        "type": "charge_setups"
                    },
                    {
                        "id": "15550",
                        "type": "charge_recurrings"
                    }
                ]
            }
        }
    },
    "meta": {
        "server_current_time": "2025-07-28T10:23:32.711955+0300"
    }
}