3.23. /api/v2/void

Введение

Void может быть обработан только для транзакций Sale и Capture с финальным успешным статусом (см. Статусы). Чтобы выполнить запрос Void, отправьте запрос HTTPS POST на указанные URL и параметры. Для аутентификации используйте SHA-1.

API URL

Примечание

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

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

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

https://sandbox.sbctech.ru/paynet/api/v2/void/ENDPOINTID

https://gate.sbctech.ru/paynet/api/v2/void/ENDPOINTID

https://sandbox.sbctech.ru/paynet/api/v2/void/group/ENDPOINTGROUPID

https://gate.sbctech.ru/paynet/api/v2/void/void/ENDPOINTGROUPID

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

Примечание

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

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

В значениях параметров необходимо экранировать следующие символы: & + «.

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

Описание

Значение

login

Логин Присоединяющейся Стороны в Платёжном Шлюзе.
Необходимость: Обязательно
Тип: String
Длина: 20

orderid

Уникальный идентификационный номер транзакции, присвоенный системой SBC.
Необходимость: Обязательно
Тип: String
Длина: 20

client_orderid

Уникальный идентификационный номер Присоединяющейся Стороны.
Необходимость: Обязательно
Тип: Numeric
Длина: 10

amount

Этот необязательный параметр указывает сумму для Reversal.
Необходимость: Обязательно
Тип: String
Длина: 10

currency

Валюта, в которой проводится операция (см. Коды валют). Примеры значений: USD для доллара США, EUR для европейского евро, RUB для российского рубля.
Необходимость: Условно
Тип: String
Длина: 3

control
Контрольная сумма, сгенерированная SHA-1. Строка для подписи представляет собой объединение следующих параметров:
1. Параметр запроса: login
2. Параметр запроса: client_orderid
3. Параметр запроса: orderid
4. merchant_control (Контрольный ключ, назначенный для аккаунта Присоединяющейся стороны в системе SBC).
Необходимость: Условно
Тип: String
Длина: 128

comment

Краткое описание.
Необходимость: Обязательно
Тип: String
Длина: 50

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

Примечание

Ответ имеет заголовок 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 конкретному запросу от Присоединяющейся стороны.

end-point-id

Идентификатор терминала, используемый для транзакции.

error-message

Для транзакций в статусе error этот параметр будет содержать причину отклонения или сведения об ошибке.

error-code

Код ошибки для транзакций в статусе error.

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

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

login=Test
&client_orderid=55
&orderid=6862995
&comment=Service not provided
&control=246e0a2074f9e4b84cff59b2567ed48ec3aab87d

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

HTTP/1.1 200 OK
Server: server
Date: Tue, 16 Aug 2022 06:57:40 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: 138

type=async-response
&serial-number=00000000-0000-0000-0000-000002ddae76
&merchant-order-id=55
&paynet-order-id=6862995
&end-point-id=39914

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

HTTP/1.1 200 OK
Server: server
Date: Tue, 16 Aug 2022 07:21:37 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: 148

type=validation-error
&serial-number=00000000-0000-0000-0000-000002ddae78
&merchant-order-id=Test
&error-message=INVALID_CONTROL_CODE
&error-code=2

Коллекция Postman

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

Endpointid or groupid

input ENDPOINTID or ENDPOINTGROUPID

login
client_orderid

input Invoice Number

orderid
amount
currency
merchant_control

input Control Key

comment

String to sign
Signature