3.1. /api/v2/account-verification
Введение
Верификация аккаунта инициируется через HTTPS POST запрос, используя URL и параметры, указанные ниже. Используйте SHA-1 шифрование для аутентификации. См. Статусы транзакций.
API URL
Интеграционная среда |
Производственная среда |
---|---|
https://sandbox.sbctech.ru/paynet/api/v2/account-verification/ENDPOINTID |
https://gate.sbctech.ru/paynet/api/v2/account-verification/ENDPOINTID |
https://sandbox.sbctech.ru/paynet/api/v2/account-verification/group/ENDPOINTGROUPID |
https://gate.sbctech.ru/paynet/api/v2/account-verification/group/ENDPOINTGROUPID |
Параметры запроса
Note
Warning
В значениях параметров необходимо экранировать следующие символы: & + “.
Название параметра |
Описание |
Значение |
---|---|---|
client_orderid |
Уникальный идентификационный номер Присоединяющейся Стороны. |
Необходимость : ОбязательноТип : StringДлина : 128 |
order_desc |
Краткое описание. |
Необходимость : ОбязательноТип : StringДлина : 64k |
address1 |
Адрес Плательщика 1. |
Необходимость : ОбязательноТип : StringДлина : 50 |
city |
Город Плательщика. |
Необходимость : ОбязательноТип : StringДлина : 50 |
zip_code |
Почтовый индекс Плательщика. |
Необходимость : ОбязательноТип : StringДлина : 10 |
country |
Страна Плательщика. Для списка действительных кодов см. Коды стран. |
Необходимость : ОбязательноТип : StringДлина : 2 |
Адрес электронной почты Плательщика. |
Необходимость : ОбязательноТип : StringДлина : 50 |
|
cvv2 |
CVV2-код Плательщика. CVV2 (Card Verification Значение) — это трех- или четырех-значное число ПОСЛЕ номера кредитной карты в области подписи карты. |
Необходимость : ОбязательноТип : NumericДлина : 3-4 |
ipaddress |
IP-адрес плательщика, также включен в проверки на мошенничество. |
Необходимость : ОбязательноТип : StringДлина : 45 |
control |
Контрольная сумма, сгенерированная SHA-1. Строка для подписи представляет собой объединение следующих параметров:
1. <ENDPOINTID | ENDPOINTGROUPID> (см: Request URL)
2. Параметр запроса: client_orderid
3. Параметр запроса: email
4. merchant_control (Контрольный ключ, назначенный для аккаунта Присоединяющейся Cтороны в системе SBC).
|
Необходимость : ОбязательноТип : StringДлина : 128 |
first_name |
Имя Плательщика. |
Необходимость : УсловноТип : StringДлина : 50 |
last_name |
Фамилия Плательщика. |
Необходимость : УсловноТип : StringДлина : 50 |
cardrefid |
ИД ссылки на карту, полученный на шаге Регистрации Карты. |
Необходимость : УсловноТип : StringДлина : 50 |
ssn |
Последние четыре цифры номера социального страхования Плательщика. |
Необходимость : УсловноТип : NumericДлина : 32 |
birthday |
Дата рождения Плательщика в формате ГГГГММДД. |
Необходимость : УсловноТип : NumericДлина : 8 |
state |
Штат Плательщика. Для списка действительных кодов штатов см. Обязательные коды штатов. Требуется для США, Канады и Австралии. |
Необходимость : УсловноТип : StringДлина : 2-3 |
phone |
Полный международный номер телефона Плательщика, включая код страны. |
Необходимость : УсловноТип : StringДлина : 15 |
cell_phone |
Полный номер мобильного телефона Плательщика, включая код страны. |
Необходимость : УсловноТип : StringДлина : 15 |
credit_card_number |
Номер банковской карты Плательщика. Нужно отправлять или комбинацию из credit_card_number, card_printed_name, expire_month и expire_year, или параметр card_recurring_payment_id, но не все в одном запросе. |
Необходимость : УсловноТип : NumericДлина : 20 |
card_printed_name |
Имя владельца карты, напечатанное на банковской карте. |
Необходимость : УсловноТип : StringДлина : 128 |
expire_month |
Месяц окончания срока действия банковской карты. |
Необходимость : УсловноТип : NumericДлина : 2 |
expire_year |
Год окончания срока действия банковской карты. |
Необходимость : УсловноТип : NumericLength : 4 |
site_url |
URL-адрес сайта электронной коммерции, откуда происходит платеж. |
Необходимость : УсловноТип : StringДлина : 128 |
purpose |
Назначение платежа. Параметр может использоваться для указания и т. д.). Примеры значений: +7123456789; gamer0001@ereality.com и т. д. Это значение может проверяться системой защиты от мошенничества. |
Необходимость : УсловноТип : StringДлина : 128 |
server_callback_url |
URL-адрес, по которому будет отправлен обратный вызов с результатом транзакции. Присоединяющаяся Сторона может использовать server callback URL для обработки завершения транзакции, т.е. собирать данные оплаты в информационной системе Присоединяющейся Стороны. Для получения информации о списке параметров, которые посылаются вместе с обратным вызовом сервера в параметре server_callback_url, см. Параметры Обратного Вызова Присоединяющейся Стороны. |
Необходимость : УсловноТип : StringДлина : 128 |
Параметры запроса SBP
Название параметра |
Описание |
Значение |
---|---|---|
client_orderid |
Уникальный идентификатор заказа, присвоенный Присоединяющейся Стороной. |
Необходимость : ОбязательноТип : StringДлина : 128 |
order_desc |
Описание заказа. |
Необходимость : ОбязательноТип : StringДлина : 64k |
amount |
Сумма к оплате. Сумма должна быть указана в минимальных единицах с “.” разделителем. Например, 100.5 в RUB означает 100 российских рублей и 50 копеек. |
Необходимость : ОбязательноТип : NumericДлина : 10 |
currency |
Валюта, в которой проводится операция (см. Коды валют). Примеры значений: USD для доллара США, EUR для европейского евро, RUB для российского рубля. |
Необходимость : ОбязательноТип : StringДлина : 3 |
address1 |
Адрес Плательщика, строка 1. |
Необходимость : ОбязательноТип : StringДлина : 50 |
city |
Город Плательщика. |
Необходимость : ОбязательноТип : StringДлина : 50 |
zip_code |
Почтовый индекс Плательщика. |
Необходимость : ОбязательноТип : StringДлина : 10 |
country |
Страна Плательщика. Для списка действительных кодов см. Коды стран. |
Необходимость : ОбязательноТип : StringДлина : 2 |
phone |
Полный международный номер телефона Плательщика, включая код страны. |
Необходимость : ОбязательноТип : StringДлина : 15 |
Адрес электронной почты Плательщика. |
Необходимость : ОбязательноТип : StringДлина : 50 |
|
ipaddress |
IP-адрес плательщика, также включен в проверки на мошенничество. |
Необходимость : ОбязательноТип : StringДлина : 45 |
control |
Контрольная сумма, сгенерированная SHA-1. Строка для подписи представляет собой объединение следующих параметров:
1. <ENDPOINTID | ENDPOINTGROUPID> (см: Request URL)
2. Параметр запроса: client_orderid
3. Параметр запроса: amount в минимальных денежных единицах
4. Параметр запроса: email
5. merchant_control (Контрольный ключ, назначенный для учетной записи Присоединяющейся Cтороны в SBC).
|
Необходимость : ОбязательноТип : StringДлина : 40 |
redirect_url |
URL-адрес, на который будет перенаправлен Плательщик после получения финального статуса транзакции. Перенаправление будет осущствлено в независимости от финального статуса (успешно, неуспешно и т.д.). См. Статусы.
Присоединяющаяся Сторона не должна использовать параметры, которые посылаются вместе с HTTP-запросом перенаправления на обработку статуса транзакции. Вместо этого Присоединяющаяся Сторона может использовать server_callback_url или АПИ команду запроса статуса. Если же нет необходимости перенаправлять Плательщика, вписать http://https://doc.sbctech.ru/. Использовать или параметр redirect_url, или комбинацию параметров redirect_success_url и redirect_fail_url, не оба.
|
Необходимость : УсловноТип : StringДлина : 1024 |
cell_phone |
Полный номер мобильного телефона Плательщика, включая код страны. |
Необходимость : УсловноТип : StringДлина : 15 |
site_url |
URL-адрес сайта электронной коммерции, откуда происходит платеж. |
Необходимость : УсловноТип : StringДлина : 128 |
purpose |
Назначение платежа. Параметр может использоваться для указания пополняемого счёта (счета мобильных телефонов, игровые учётные записи и т. д.). Примеры значений: +7123456789; gamer0001@ereality.com и т. д. Это значение может проверяться системой защиты от мошенничества. |
Необходимость : УсловноТип : StringДлина : 128 |
server_callback_url |
URL-адрес, по которому будет отправлен обратный вызов с результатом транзакции.
Присоединяющаяся Сторона может использовать server callback URL для обработки завершения транзакции, т.е. собирать данные оплаты в информационной системе Присоединяющейся Стороны. Для получения информации о списке параметров, которые посылаются вместе с обратным вызовом сервера в параметре server_callback_url, см. Параметры Обратного Вызова Присоединяющейся Стороны.
|
Необходимость : УсловноТип : StringДлина : 1024 |
merchant_data |
Дополнительные сведения о транзакции для Присоединяющейся Стороны, которые можно прикрепить к транзакции и получить обратно в ответе на запрос статуса, обратном вызове Присоединяющейся Стороны или server_callback_url. Может содержать данные, которые будут полезны во внешней системе Присоединяющейся Стороны, например VIP клиент, телевизионная промо-кампания.
Информация возвращается в ответе на запрос статуса и в обратном вызове Присоединяющейся Стороны.
|
Необходимость : УсловноТип : StringДлина : 64k |
dapi_imei |
Уникальный идентификатор устройства. |
Необходимость : УсловноТип : StringДлина : 32 |
Параметры ответа
Note
Параметры ответа |
Описание |
---|---|
type |
Тип ответа. Может принимать такие значения как - async-response, validation-error, error и т.д.
Если тип равен validation-error или error, параметры error-message и error-code будут содержать сведения об ошибке.
|
paynet-order-id |
Номер заказа в системе SBC. |
merchant-order-id |
Номер заказа в системе Присоединяющейся Стороны. |
serial-number |
Уникальный номер, присвоенный сервером Doc2.0 конкретному запросот Присоединяющейся Стороны. |
error-message |
Для транзакций в статусе error этот параметр будет содержать причину отклонения или сведения об ошибке. |
error-code |
Код ошибки для транзакций в статусе error. |
Пример запроса
POST /paynet/api/v2/account-verification/39915 HTTP/1.1
User-Agent: curl/7.83.0
Accept: */*
Content-Length: 527
Content-Type: application/x-www-form-urlencoded
Connection: close
client_orderid=34T43R77N
&order_desc=Test Order Описание
&first_name=John
&last_name=Smith
&birthday=19820115
&address1=100 Main st
&city=Seattle
&state=WA
&zip_code=98102
&country=US
&phone=+12063582043
&cell_phone=+19023384543
&email=john.smith@gmail.com
&ipaddress=65.153.12.232
&site_url=www.google.com
&credit_card_number=4666034752545240
&card_printed_name=CARD HOLDER
&expire_month=12
&expire_year=2099
&cvv2=123
&purpose=user_account1
&server_callback_url=https://httpstat.us/200
&merchant_data=VIP customer
&control=5112b51084be33fa331d995d17b9d82af3bfbbc9
Пример успешного ответа
HTTP/1.1 200
Server: server
Date: Thu, 27 Apr 2023 14:03:58 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: 145
type=async-response
&serial-number=00000000-0000-0000-0000-000002e34518
&merchant-order-id=34T43R77N
&paynet-order-id=6994016
&end-point-id=39915
Пример неуспешного ответа
HTTP/1.1 200
Server: server
Date: Mon, 22 May 2023 11:14:25 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: 152
type=validation-error
&serial-number=00000000-0000-0000-0000-000002e5c583
&merchant-order-id=34T43R77N
&error-message=INVALID_CONTROL_CODE
&error-code=2
Коллекция Postman
Конструктор запросов
String to sign |
---|
Signature |
---|
|