3.25. /api/v4/create-card-ref

Введение

Создание Card reference ID и Recurring Payment ID инициируется через HTTPS POST запрос с использованием URL и параметров, указанных ниже. Для аутентификации используйте OAuth RSA-SHA256.

API URL

Примечание

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

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

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

https://sandbox.sbctech.ru/paynet/api/v4/create-card-ref/ENDPOINTID

https://gate.sbctech.ru/paynet/api/v4/create-card-ref/ENDPOINTID

https://sandbox.sbctech.ru/paynet/api/v4/create-card-ref/group/ENDPOINTGROUPID

https://gate.sbctech.ru/paynet/api/v4/create-card-ref/group/ENDPOINTGROUPID

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

Примечание

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

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

Описание

login

Логин Присоединяющейся стороны в Системе.

client_orderid

Уникальный идентификатор заказа, присвоенный Присоединяющейся Стороной.

orderid

Идентификатор заказа транзакции, присвоенный Платёжным Шлюзом.

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

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

Примечание

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

Параметр ответа на регистрацию

Описание

type

Тип ответа. Может быть create-card-ref-response, validation-error, error. Если type равен validation-error или error, параметры error-message и error-code содержат детали ошибки.

serial-number

Уникальный номер, присваиваемый сервером SBC конкретному запросу от Присоединяющейся стороны.

card-ref-id

Card reference ID, используемый в последующих рекуррентных платежах.

unq-card-ref-id

Уникальный идентификатор ссылки на карту для каждого PAN. Может использоваться Присоединяющейся стороной для программ лояльности или контроля мошенничества.

recurring-payment-id

ID токенизированных данных держателя карты Плательщика, называемый Recurring Payment ID (RPI).

dst-card-ref-id

Card reference ID Получателя, используемый в последующих рекуррентных платежах. Может использоваться только в transfer API.

dst-unq-card-ref-id

Уникальный card reference ID Получателя для каждого PAN. Может использоваться Присоединяющейся Стороной для программ лояльности или контроля фрода. Может использоваться только в transfer API.

dst-recurring-payment-id

ID токенизированных данных держателя карты Получателя, называемый Recurring Payment ID (RPI). Может использоваться только в transfer API.

error-message

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

error-code

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

status

Подробности см. в Список статусов.

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

POST /paynet/api/v4/create-card-ref/39915 HTTP/1.1
Host: sandbox.sbctech.ru
User-Agent: curl/7.83.0
Accept: */*
Authorization: OAuth oauth_consumer_key="TestMerchant", oauth_nonce="KT6cZmuVGqg0V6Jm2RE3q4o79KXC1v2q", oauth_signature="KucF0eYk3WZCV7oKwOi1z6PR%2BkHxiZwPucD6Sx%2BX2mV%2BbaidPy9K9USh8ciMKM60NNl1LYYjywdaErB1uTIdFFbQ8ZKs8M1smaMPOaHDaApceTOlDh6E7u3BzBTKYhBc%2BWnksZz9Wyz8%2B39lHCIODo0KZmNmXCTjjZmlx%2FrFNkK%2FhwJV9Kwq1nPbA5QZTkF686O0O0lHFy3Prx649AIRgsrqDLb5%2FgHL9M8fSScVUPnGdLGJ2hSgKJFpIOFibT0nC89Xg8odn1hR9WIa1650glaqZntSkocBzXAkOKa7kIbSOZW1sFCiBjksy6o1sny9hmc%2F9cC9t86RoEY1QhVYuvOLztQm1dLhpRy%2FPOL9LCmIzO3B%2FUB2wJUXPkEyFsSLZVeqQl%2B0IukljV6Cr1ZfuyUktbvvXJsnod5AK%2FsV2GaxEf%2BttqqWv%2FFNjPLoUZYrPB6rKsIpw%2FOftinIwIxYzLY3FMmbKQd6zxnMJLJm7M2s6cQFGiAnfgvZFAMZhugBuuigy4T9Ckq1t5N9vQkl2htDv0TTnswx50wpF%2F7OKiXTVFNqOE%2FCj%2F07ZwZbxbD%2FMxKhOhfNMME1jGxzgI0wEj1166eKpxnCOk%2BTlYTJvNW5%2BbKuGnU43Q2Nmga0aQ007NKRfIV%2FWk6e%2BUuGO48wGdi0CiKxS9hpnpvjyPLc%2BsA%3D", oauth_signature_method="RSA-SHA256", oauth_timestamp="1673335450", oauth_version="1.0"
Content-Length: 40
Content-Type: application/x-www-form-urlencoded
Connection: close

client_orderid=34T43R77N
&orderid=6868305

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

HTTP/1.1 200
Server: server
Date: Tue, 10 Jan 2023 07:24:36 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: 174

type=create-card-ref-response
&serial-number=00000000-0000-0000-0000-000002de3113
&card-ref-id=1461608
&recurring-payment-id=1491863
&dst-card-ref-id=1461608
&status=approved

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

HTTP/1.1 403
Server: server
Date: Tue, 10 Jan 2023 07:34:08 GMT
Content-Type: text/html
Content-Length: 735
Connection: close
X-XSS-Protection: 1
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000

<!DOCTYPE html>
<html>
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
    <title>403</title>

    <style type="text/css">
        body {
            font-family: Arial, sans-serif;
            font-size: 130%;
            background-color: #eee;
        }

        p {
            margin: 10em auto 0;
            width: 500px;
            border: 1px solid gray;
            text-align: center;
            vertical-align: middle;
            padding: 40px 20px;
            background-color: #fff;
            -webkit-border-radius: 20px;
            -moz-border-radius: 20px;
            border-radius: 20px;
        }
    </style>
</head>

<body>
    <p>Access is denied</p>
</body>
</html>

Коллекция Postman

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

Вставьте приватный ключ PKCS#1 PEM для среды sandbox в поле ниже. Конструктор запросов поддерживает длину ключа до 4096.
Debug form
URL
login

your login will be used as Consumer Public for OAuth header, not included as request body parameter

client_orderid
orderid

Normalized parameters string to sign, according to OAuth 1.0a rules
POST body parameters to submit
OAuth 1.0a headers to submit.
HEX Encoded Signature
* HEX encoded string is for debug purposes only. You shouldn't send this string to the server neither in HEX nor in Encoded HEX representation.
Base64 Encoded Signature
* Binary RSA-SHA256 signature directly encoded in base64 should be sent to the server.