3.6. /api/v2/close-day

Введение

Gate Close Day инициируется запросом HTTPS POST с использованием указанных ниже URL и параметров. Для аутентификации используйте OAuth HMAC-SHA1. См. статусы.

API URL

Примечание

Путь API URL не должен быть задан фиксированным значением, т.к. он может быть изменён позднее.

Интеграционная среда

Производственная среда

https://sandbox.sbctech.ru/paynet/api/v2/close-day/ENDPOINTID

https://gate.sbctech.ru/paynet/api/v2/close-day/ENDPOINTID

Параметры запроса

Примечание

Запрос должен иметь заголовок content-type=application/x-www-form-urlencoded.

Название параметра

Описание

Значение

day_close_request_id

Уникальный идентификатор запроса. Может содержать буквы и цифры.
Необходимость: Обязательно
Тип: String
Length: 8-32

sale_approved_count

Количество подтверждённых транзакций Sale.
Необходимость: Опционально
Тип: String
Длина: -

sale_approved_sum

Сумма подтверждённых транзакций Sale.
Необходимость: Опционально
Тип: String
Длина: -

reversal_approved_count

Количество подтверждённых транзакций Reversal.
Необходимость: Опционально
Тип: String
Длина: -

reversal_approved_sum

Сумма подтверждённых транзакций Reversal.
Необходимость: Опционально
Тип: String
Длина: -

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

Примечание

Ответ имеет заголовок Content-Type: text/html;charset=utf-8. Все поля имеют кодировку x-www-form-urlencoded, с символом (0xA) в конце значения каждого параметра.

Название параметра

Описание

Значение

status

Close Day транзакция статус.
Тип: String

gateId

Close Day Gate ID.
Тип: Long

isDayClosing

Метка закрытия дня. Если true, шлюз блокируется.
Тип: Boolean

gateCloseDate

Дата закрытия дня (Close Day) шлюза.
Тип: String

epntId

Свойство, назначенное банком конечной точке при её настройке в банковской системе.
Тип: Long

saleApprovedCount

Количество подтверждённых транзакций Sale.
Тип: String

saleAmount

Сумма подтверждённых транзакций Sale.
Тип: String

reversalApprovedCount

Количество подтверждённых транзакций Reversal.
Тип: String

reversalAmount

Сумма подтверждённых транзакций Reversal.
Тип: String

code39

Результат закрытия дня. Ответ банка на процедуру закрытия дня шлюза.
Тип: String

RRN

Номер закрытия дня, сгруппированный по идентификатору конечной точки.
Тип: String

theRequestSerialNumber

Порядковый номер запроса Close Day.
Тип: String

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

POST /paynet/api/v2/close-day/39914 HTTP/1.1
Host: sandbox.sbctech.ru
User-Agent: curl/7.83.0
Accept: */*
Content-Length: 119
Content-Type: application/x-www-form-urlencoded
Connection: close

"day_close_request_id": {string},
"sale_approved_count": {string},
"sale_approved_sum": {string},
"reversal_approved_count": {string},
"reversal_approved_sum": {string}

Пример успешного ответа

Информация о закрытом дне появится в ответе Платёжного Шлюза по мере её получения от процессоров (при одновременном закрытии нескольких гейтов). После закрытия дня гейта статус ответа будет установлен как «finished» независимо от того, было ли закрытие дня на всех гейтах успешным или часть гейтов (либо все) закрылась с ошибкой.
 HTTP/1.1 200 OK
 Server: server
 Date: Mon, 22 Aug 2022 13:15:19 GMT
 Content-Type: text/html;charset=utf-8
 Connection: close
 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: 1412


"response": {
  "status": "finished",
      "gates": [ {
            "gateId": 193,
            "isDayClosing": false,
            "gateCloseDate": "Mon Dec 10 14:44:21 MSK 2018",
            "epntId": 1,
            "saleApprovedCount": "2334",
            "saleAmount": "87328428482.00",
            "reversalApprovedCount": "123",
            "reversalAmount": "12393423.00",
            "code39": "000",
            "RRN": "2034829434"
            }, {
            "gateId": 82,
            "isDayClosing": false,
            "gateCloseDate": "Mon Dec 10 14:44:21 MSK 2018",
            "epntId": 1,
            "saleApprovedCount": "2334",
            "saleAmount": "87328428482.00",
            "reversalApprovedCount": "123",
            "reversalAmount": "12393423.00",
            "code39": "000",
            "RRN": "2034829434"
            }, {
            "gateId": 317,
            "isDayClosing": false,
            "gateCloseDate": "Mon Dec 10 14:44:21 MSK 2018",
            "epntId": 1,
            "saleApprovedCount": "2334",
            "saleAmount": "87328428482.00",
            "reversalApprovedCount": "123",
            "reversalAmount": "12393423.00",
            "code39": "000",
            "RRN": "2034829434"
      }
      ]
    },
    "theRequestSerialNumber": "00000000-0000-0000-0000-00000000002c"

Предупреждение

Если после Close Day API шлюзы остаются заблокированными (в теле ответа для «status»: «finished» у шлюза указано «isDayClosing»: true), используйте инструмент снятия блокировки в интерфейсе Платёжного Шлюза.

Пример неуспешного ответа

Если во время процедуры Close Day Присоединяющаяся сторона отправит повторный запрос Close Day с новым идентификатором запроса, Платёжный Шлюз вернёт ответ со статусом ‘error’ и описанием ошибки. Повторно использовать идентификатор этого запроса для дальнейшего инициирования закрытия дня бессмысленно, поскольку статус error является окончательным, и идентификатор запроса всегда будет связан с этим запросом.
Если Присоединяющаяся сторона инициирует запрос с новым идентификатором запроса Endpoint, для которого Close Day уже был выполнен, и некоторые Шлюзы, связанные с Endpoint, закрылись с ошибкой (и находятся в закрытом состоянии), Платёжный Шлюз отправит ответ со статусом «error» и соответствующим описанием ошибки.
HTTP/1.1 200 OK
Server: server
Date: Mon, 22 Aug 2022 12:59:09 GMT
Content-Type: text/html;charset=utf-8
Connection: close
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: 154

   "response": {
     "status": "error",
     "errorCode": "99",
     "errorMessage": "gate is closing already"
   },
   "theRequestSerialNumber": "00000000-0000-0000-0000-000000000020"

Предупреждение

Чтобы решить эту проблему, вручную выполните операцию Close Day в UI Платёжного Шлюза.

Конструктор запросов

HTTP method
URL
parameters
version
consumer key
consumer secret
timestamp

nonce

signature method

normalized parameters
signature base string
signature
authorization header