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

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

POST {base_url}/api/v3/resellers/{reseller_id}/payments/{document_id}

{
    "data": {
        "attributes": {
            "payment_method_id": "{payment_method_id}",
            "total": {total},
            "currency_code": "{currency_code}"
        }
    }
}

Аргументы

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

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

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

POST /api/v3/resellers/1/payments/2005258
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",
            "total": 123.45,
            "currency_code": "USD"
        }
    }
}

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

{
    "data": {
        "id": "3212",
        "type": "payments",
        "attributes": {
            "created_at": "2023-10-26T16:37:31.534421+0300",
            "updated_at": "2023-10-26T16:37:43.325470+0300",
            "account_id": 478,
            "discount_amount": "0.0",
            "total": "123.45",
            "currency_code": "USD",
            "comment": "1",
            "status": "completed",
            "document_id": "2005258",
            "expiration_date": null,
            "payment_method_id": 2,
            "requester_ip": "10.11.12.13",
            "manager_id": 6,
            "purpose": "",
            "external_total": null,
            "external_currency": null,
            "payment_method_name": "Check",
            "closed_at": "2023-10-26T16:37:43.325470+0300"
        },
        "relationships": {
            "orders": {
                "data": []
            },
            "invoices": {
                "data": []
            },
            "charges": {
                "data": []
            },
            "reseller": {
                "data": {
                    "id": "1",
                    "type": "resellers"
                }
            },
            "account": {
                "data": {
                    "id": "478",
                    "type": "accounts"
                }
            },
            "payment_method": {
                "data": {
                    "id": "2",
                    "type": "payment_methods"
                }
            }
        }
    }
}

Ошибки