3.4. /api/v2/capture

Введение

Списание инициируется через запрос HTTPS POST на указанный ниже URL с использованием указанных параметров. Для аутентификации запроса используется SHA-1. Списание может быть вызвано только по предавторизации в конечном успешном статусе. См. Статусы транзакций.

API URL

Примечание

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

Интеграционная среда	Производственная среда
https://sandbox.sbctech.ru/paynet/api/v2/capture/ENDPOINTID	https://gate.sbctech.ru/paynet/api/v2/capture/ENDPOINTID
https://sandbox.sbctech.ru/paynet/api/v2/capture/group/ENDPOINTGROUPID	https://gate.sbctech.ru/paynet/api/v2/capture/group/ENDPOINTGROUPID

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

Примечание

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

Параметры запроса	Описание
login	Логин Присоединяющейся Стороны в Платёжном Шлюзе.
client_orderid	Идентификатор заказа Присоединяющейся Стороны для транзакции, статус которой запрашивается.
orderid	Номер заказа в системе SBC
currency	Валюта списания транзакции (см. коды валют). Примеры: USD для доллара США, EUR для евро. Этот параметр может передаваться или не передаваться.
amount	Сумма списания. Сумму необходимо указать в старших единицах с разделителем .. Например, 10.5 для USD означает 10 долларов США и 50 центов. Этот параметр может передаваться или не передаваться.
control	Контрольная сумма, сгенерированная SHA-1. Строка для подписи представляет собой объединение следующих параметров: 1. Параметр запроса:login. 2. Параметр запроса: merchant-order-id. 3. Параметр запроса: paynet-order-id. 4. Параметр запроса:amount в минимальных денежных единицах (если отправлен). 5. Параметр запроса: currency (если отправлена сумма). 6.:ex:merchant_control (Контрольный ключ, назначенный для учетной записи Присоединяющейся Cтороны в SBC).

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

Примечание

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

Параметры ответа	Описание
type	Тип ответа. Может принимать такие значения как: async-response, validation-error, error и т.д. Если тип ответа validation-error или error, параметры error-message и error-code будут содержать детали ошибки.
paynet-order-id	Идентификатор заказа, присвоенный SBC.
merchant-order-id	Идентификатор заказа Присоединяющейся Стороны.
serial-number	Уникальный номер, присваиваемый сервером SBC конкретному запросу от Присоединяющейся стороны.
error-message	Для транзакций в статусе error этот параметр будет содержать причину отклонения или сведения об ошибке.
error-code	Код ошибки для транзакций в статусе error.
end-point-id	Идентификатор терминала, используемый для транзакции.

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

POST /paynet/api/v2/capture/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

login=TestMerchant
&client_orderid=902B4FF5
&orderid=6863088
&amount=345
&currency=USD
&control=da832c0fcff0105728e26465d5f99e6f83179a45

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

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: 140

type=async-response
&serial-number=00000000-0000-0000-0000-000002ddb06a
&merchant-order-id=902B4FF5
&paynet-order-id=6863088
&end-point-id=37211

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

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

pe=validation-error
&serial-number=00000000-0000-0000-0000-000002ddb06b
&error-message=Can+not+make+capture+for+order+state+AUTH_3D_VALIDATING
&error-code=27

Open API Collection

Open this method in the OpenAPI Reference

View in OpenAPI

Коллекция Postman

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

endpointid or groupid	input ENDPOINTID or ENDPOINTGROUPID
login
client_orderid	input Invoice Number
orderid
amount
currency
merchant_control	input Control Key

String to sign

Signature