.. meta:: :description: Конечная точка API /api/v4/process-recurring-payment SBC: ручной запуск обработки одного настроенного рекуррентного платежа вне его расписания. .. _api_v4_process-recurring-payment: /api/v4/process-recurring-payment ##################################### .. role:: ex .. role:: code Введение ^^^^^^^^^^^^^^^^ | Если запрос принят без ошибок, платежный шлюз находит профиль повторяющегося платежа по предоставленному recurring-payment-id и инициирует новую повторяющуюся транзакцию, используя данные платежа, сохраненные в этом профиле. | Процесс повторяющегося платежа инициируется через запрос :code:`HTTPS POST` с использованием :ref:`URLs` и :ref:`parameters`, указанных ниже. Используйте :ref:`RSA-SHA256` для аутентификации. .. _api_v4_process-recurring-payment_request_url: API URL ^^^^^^^^^^^^ .. note:: | Путь API URL не должен быть задан фиксированным значением, т.к. он может быть изменён позднее. .. list-table:: :widths: 50, 50 :header-rows: 1 :class: longtable * - Интеграционная среда - Производственная среда * - :ex:`https://sandbox.sbctech.ru/paynet/api/v4/process-recurring-payment/ENDPOINTID` - :ex:`https://gate.sbctech.ru/paynet/api/v4/process-recurring-payment/ENDPOINTID` .. _api_v4_process-recurring-payment_request_parameters: Параметры запроса ^^^^^^^^^^^^^^^^^^^^^^ .. note:: | Запрос должен иметь content-type=application/x-www-form-urlencoded и :ref:`Заголовки авторизации`. .. list-table:: :widths: 30, 50, 20 :header-rows: 1 :class: longtable * - Название параметра - Описание - Значение * - :code:`client-orderid` - Идентификатор заказа Присоединяющейся стороны. - | ``Необходимость``: Обязательно | ``Тип``: String | ``Длина``: 128 * - :code:`recurring-payment-id` - Повторяющийся идентификатор, присвоенный заказу отделом QA. - | ``Необходимость``: Обязательно | ``Тип``: String | ``Длина``: 10 * - :code:`amount` - Сумма валюты должна совпадать с валютой назначенного проекта. По достижении даты окончания, регулярный платеж перейдет в статус - остановлен. Поддерживается для типов SRC и DST. Требуется, если не используются:code:`amount-from` и:code:`amount-to` или:code:`amount-sequence`. - | ``Необходимость``: Условно | ``Тип``: Numeric | ``Длина``: 10 .. _api_v4_process-recurring-payment_response_parameters: Параметры ответа ^^^^^^^^^^^^^^^^^^^^^^^ .. note:: | Ответ имеет заголовок Content-Type: text/html;charset=utf-8. Все поля имеют кодировку x-www-form-urlencoded, с символом (0xA) в конце значения каждого параметра. .. list-table:: :widths: 35, 65 :header-rows: 1 :class: longtable * - Параметры ответа - Описание * - :code:`type` - Тип ответа. Пример: :ex:`process-recurring-payment-response`, :ex:`validation-error`, :ex:`error`. Если тип равен :ex:`validation-error` или :ex:`error`, параметры :ex:`error-message` и :ex:`error-code` содержат сведения об ошибке. * - :code:`status` - Если запрос принят, этот параметр имеет значение :code:`processing`. Это не статус транзакции. * - :code:`serial-number` - Уникальный номер, присваиваемый сервером SBC конкретному запросу от Присоединяющейся стороны. Пример запроса ^^^^^^^^^^^^^^^^^^^^ .. code-block:: http POST /paynet/api/v4/process-recurring-payment/ HTTP/1.1 User-Agent: curl/8.4.0 Accept: */* Authorization: OAuth oauth_consumer_key="ErwinTestMerchant", oauth_nonce="XGsxKTfd4uiaQKOSyXkHQwKxFqLCEKRz", oauth_signature="KX7KEjFUEJo8rLJ2PvusGDlu5cxqMm%2BU%2Bn%2F1KxH18QUeZ57QghfnXyiXKCxwAr76uxMk9X10QL8YI4kuEHVmxThIomtIZML3yRLESneHNqZzlwXvTSG5o%2B7DTSdAeNGZ40PIbF4XAUzwp%2FQbpYGWBS4Yk36%2BPQbziJlsFa21gRo7e03fizxPEIYi1algEqOT5uu%2F07Yci6NsSyGGMGo4vyDhqPMLuDcaTeO%2Fzr51RfRa4jh2bT4tUriZLVrjYP0AJeHGlZdosTkqEyVAz5Q5yD67xmjUGlW4luezOWdR70wrfQ8JZ7QuXzueAb9TqyZfi%2BvCD4MrhXG299ujWUUtZ%2F8qi09p%2F7GmBiFSud7wgMjPGOC%2BijBEFIpsfiBFzd6%2FX7MBLAdTpHXrExT2C71dJysde31isAMVuIIuvXogY7YE0ZttWY1oYqcWDNSWXsUx5pQTjbBf1vyJB3CqtAFVFi6LwckqsYTAXkxfp%2B2IgFFhadEvf35XzFPv%2FEjsTqRLJuPYBa85mK9vaY7WJRtX89TjSdEPulFnz1EEFg5KHe5WxVp9GFw2XqLneqBu%2FwGAGg3NXRumBMHK3E%2Bh96cVdU5b3AkqVjS2Q36jpQtAhUIIGYyT02n4W9avhw2cHCJzErqGjALHJjkFQD1bhDRKyTm1Fqeh%2BplDaPwDKjy5EHY%3D", oauth_signature_method="RSA-SHA256", oauth_timestamp="1721316898", oauth_version="1.0" Content-Length: 407 Content-Type: application/x-www-form-urlencoded Connection: keep-alive recurring-payment-id=1492124 &amount=10 &client-orderid=1575634981130 Пример успешного ответа ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: http HTTP/1.1 200 Server: server Date: Thu, 18 Jul 2024 15:35:46 GMT Content-Type: text/html;charset=utf-8 Connection: keep-alive Keep-Alive: timeout=60 Vary: Accept-Encoding X-XSS-Protection: 1 X-Content-Type-Options: nosniff Strict-Transport-Security: max-age=31536000 Content-Language: en-US Strict-Transport-Security: max-age=31536000 Content-Length: 110 type=process-recurring-payment-response &serial-number=00000000-0000-0000-0000-000002f36d8d &status=processing Пример неуспешного ответа ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: http HTTP/1.1 500 Server: server Date: Thu, 18 Jul 2024 15:39:05 GMT Content-Length: 61 Connection: keep-alive Keep-Alive: timeout=60 X-XSS-Protection: 1 X-Content-Type-Options: nosniff Strict-Transport-Security: max-age=31536000 Internal server error [b2a06c5a-c770-4c01-b32c-e4fcb1da4cd6] .. only:: openapi_doc_enabled Open API Collection ^^^^^^^^^^^^^^^^^^^ Open this method in the OpenAPI Reference .. raw:: html View in OpenAPI Конструктор запросов ^^^^^^^^^^^^^^^^^^^^ .. raw:: html :file: ../_static/examples/V4RecurProcess.html