3.5. /api/v2/create-card-ref

Введение

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

API URL

Примечание

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

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

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

Примечание

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

Параметры запроса	Описание
login	Логин Присоединяющейся стороны в Системе.
client_orderid	Уникальный идентификатор заказа, присвоенный Присоединяющейся Стороной.
orderid	Идентификатор заказа транзакции, присвоенный Платёжным Шлюзом.
control	Контрольная сумма, сгенерированная SHA-1. Строка для подписи представляет собой объединение следующих параметров: 1. Параметр запроса: login 2. Параметр запроса: client_orderid 3. Параметр запроса: orderid 4. merchant_control (Контрольный ключ, назначенный для аккаунта Присоединяющейся стороны в системе SBC).

Присоединяющаяся Сторона должна предоставить:code:orderid и:code:client_orderid, связанные с первой платёжной транзакцией. Это подчёркивает, что первый платёж является обязательным шагом для обработки рекуррентных платежей. Для авторизации кредитной карты информация о ней должна быть достаточной, а первоначальный платёж должен находиться в:ref:финальном статусе<statuses>.

Возвращаемые Recurring Payment ID и/или Card Reference ID представляют собой токены, ссылающиеся на данные держателя карты, хранящиеся на стороне платежного шлюза. Для определения типа поддерживаемого токена в параметрах запроса обратитесь к соответствующей API-команде. Использование данного ID: 1.В прямых API-вызовах — может передаваться вместо данных держателя карты для инициирования новой транзакции. 2. В API-вызовах для форм — позволяет предзаполнить платежную форму ранее сохраненными данными карты.

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

Примечание

Ответ имеет заголовок 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 будут содержать сведения об ошибке.
serial-number	Уникальный номер, присваиваемый сервером SBC конкретному запросу от Присоединяющейся стороны.
card-ref-id	Ссылочный идентификатор, для использования в повторных оплатах.
unq-card-ref-id	Уникальный идентификатор ссылки на карту для каждого PAN. Может использоваться Присоединяющейся стороной для программ лояльности или контроля мошенничества.
status	См. список статусов.
error-message	Для транзакций в статусе:ex:declined или:ex:error этот параметр будет содержать причину отклонения или сведения об ошибке.
error-code	Код ошибки для транзакций в статусе:ex:declined или:ex:error.

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

POST /paynet/api/v2/create-card-ref/46750 HTTP/1.1
Host: https://sandbox.sbctech.ru
User-Agent: curl/7.85.0
Accept: */*
Content-Length: 100
Content-Type: application/x-www-form-urlencoded
Connection: close

login=login
&client_orderid=902B4FF5
&orderid=6937242
&control=717349cab3fcab2c13c93ff5770ae07a7b8e0727

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

HTTP/1.1 200
Server: server
Date: Tue, 07 Feb 2023 08:46:24 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: 144

type=create-card-ref-response
&serial-number=00000000-0000-0000-0000-000002e110a2
&card-ref-id=1461670
&unq-card-ref-id=2463777
&status=approved

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

HTTP/1.1 200
Server: server
Date: Tue, 07 Feb 2023 08:55:26 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: 123

type=validation-error
&serial-number=00000000-0000-0000-0000-000002e110ad
&error-message=INVALID_CONTROL_CODE
&error-code=2

Коллекция Postman

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

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

String to sign

Signature