Завершение платежа по ID

Метод Complete payment by ID используется для завершения платежа по его ID для текущего реселлера или любого из его нижестоящих реселлеров, например, при получении оплаты во внешних системах. Завершить можно только платежи со статусами Ожидает оплаты и Просрочен.

Платеж также можно завершить по его номеру document_id (см. Завершение платежа по номеру).

Для авторизации требуется API-токен менеджера (сотрудника). API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о сотруднике).

По указанному в запросе API-токену определяются:

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

PATCH {base_url}/api/v3/resellers/{reseller_id}/payments/{payment_id}

{
    "data":
    {
        "attributes":
        {
            "payment_method_id": {payment_method_id}
        }
    }
}

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
X-Api-Token	header	string	Обязательный	API-токен сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике)
Content-Type	header	string	Обязательный	Тип данных, передаваемых в запросе. Необходимо указать: application/vnd.api+json
Accept	header	string	Обязательный	Поддерживаемые типы данных в ответе. Необходимо указать: application/vnd.api+json
base_url	path	string	Обязательный	URL ActivePlatform
reseller_id	path	number	Обязательный	ID реселлера. Возможно указать ID текущего реселлера или ID любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере)
payment_id	path	number	Обязательный	ID платежа
payment_method_id	form	number	Обязательный	ID способа оплаты для завершения платежа (см. Просмотр списка способов оплаты)

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

При успешном завершении платежа метод возвращает информацию о платеже (см. Получение информации о платеже без включения в ответ дополнительной информации included о связанных объектах).

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

PATCH /api/v3/resellers/1/payments/6475
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

{
    "data":
    {
        "attributes":
        {
            "payment_method_id": 2
        }
    }
}

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

{
    "data": {
        "id": "6475",
        "type": "payments",
        "attributes": {
            "created_at": "2019-11-01T04:30:47.797788+0300",
            "updated_at": "2019-11-01T04:34:42.986099+0300",
            "account_id": 505,
            "discount_amount": "0.0",
            "total": "99.0",
			"currency_code": "USD",
            "comment": "cash",
            "status": "completed",
            "document_id": "2005258",
            "expiration_date": null,
            "payment_method_id": 2,
            "requester_ip": "10.0.0.203",
            "manager_id": 234,
			"purpose": "",
            "external_total": null,
            "external_currency": null,
            "due_date": null, 
            "payment_method_name": "Cash",
            "closed_at": "2019-11-01T04:34:42.986099+0300"
        },
        "relationships": {
            "orders": {
                "data": []
            },
            "invoices": {
                "data": []
            },
            "corrections": {
                "data": []
            },
            "reseller": {
                "data": {
                    "id": "1",
                    "type": "resellers"
                }
            },
            "account": {
                "data": {
                    "id": "505",
                    "type": "accounts"
                }
            },
            "payment_method": {
                "data": {
                    "id": "2",
                    "type": "payment_methods"
                }
            }
        }
    }
}

Ошибки

При возникновении ошибки метод возвращает описание ошибки, например, для статуса 422:

{
    "errors": {
        "title": "Only payments with \"waiting for payment/expired\" status can be completed.",
        "status": "422"
    }
}